'1.0', 'info' => [ 'style' => 'RPC', 'product' => 'Rds', 'version' => '2014-08-15', ], 'directories' => [ [ 'id' => 67326, 'title' => 'Billing', 'type' => 'directory', 'children' => [ 'TransformDBInstancePayType', 'ModifyDBInstancePayType', 'ModifyInstanceAutoRenewalAttribute', 'DescribePrice', 'DescribeRenewalPrice', 'DescribeInstanceAutoRenewalAttribute', 'RenewInstance', 'DescribeDBInstancePromoteActivity', ], ], [ 'id' => 67286, 'title' => 'Instance management', 'type' => 'directory', 'children' => [ 'CreateDBInstance', 'CreateDBInstanceForRebuild', 'DeleteDBInstance', 'RestartDBInstance', 'StopDBInstance', 'StartDBInstance', 'ModifyDBInstanceSpec', 'DestroyDBInstance', 'ModifyDasInstanceConfig', 'MigrateToOtherZone', 'ModifyDBInstanceDescription', 'ModifyDBInstanceMaintainTime', 'ModifyResourceGroup', 'ModifyHADiagnoseConfig', 'ModifyAccountSecurityPolicy', 'DescribeSupportOnlineResizeDisk', 'DescribeAvailableZones', 'DescribeAvailableClasses', 'DescribeDBInstanceAttribute', 'GetDBInstanceTopology', 'DescribeDBInstances', 'ListClasses', 'DescribeDBInstancesByExpireTime', 'DescribeRegions', 'CheckInstanceExist', 'DescribeHADiagnoseConfig', 'DescribeAnalyticdbByPrimaryDBInstance', 'CheckCloudResourceAuthorized', 'ReleaseInstanceConnection', 'DescribeDBInstanceDetail', 'DescribeDBInstancesByPerformance', 'DescribeDBInstancesForClone', 'DescribeDBInstancesAsCsv', ], ], [ 'id' => 180062, 'title' => 'Version upgrade', 'type' => 'directory', 'children' => [ 'ModifyDBInstanceAutoUpgradeMinorVersion', 'DescribeUpgradeMajorVersionPrecheckTask', 'DescribeUpgradeMajorVersionTasks', 'UpgradeDBInstanceEngineVersion', 'UpgradeDBInstanceKernelVersion', 'UpgradeDBInstanceMajorVersionPrecheck', 'UpgradeDBInstanceMajorVersion', ], ], [ 'id' => 67343, 'title' => 'Network and Connection', 'type' => 'directory', 'children' => [ 'AllocateInstancePublicConnection', 'ReleaseInstancePublicConnection', 'ModifyDBInstanceConnectionString', 'ModifyDBInstanceNetworkExpireTime', 'SwitchDBInstanceNetType', 'ModifyDBInstanceNetworkType', 'SwitchDBInstanceVpc', 'ModifyDBInstanceConfig', 'DescribeDBInstanceNetInfo', 'DescribeVSwitches', ], ], [ 'id' => 67351, 'title' => 'Primary/Secondary High Availability and Data Replication', 'type' => 'directory', 'children' => [ 'ModifyDBInstanceHAConfig', 'ModifyHASwitchConfig', 'DescribeDBInstanceHAConfig', 'DescribeHASwitchConfig', 'SwitchDBInstanceHA', ], ], [ 'id' => 67357, 'title' => 'Event History', 'type' => 'directory', 'children' => [ 'ModifyActionEventPolicy', 'DescribeEvents', 'DescribeActionEventPolicy', ], ], [ 'id' => 180072, 'title' => 'Notification', 'type' => 'directory', 'children' => [ 'QueryNotify', 'ConfirmNotify', 'DescribeRdsResourceSettings', ], ], [ 'id' => 67364, 'title' => 'Account management', 'type' => 'directory', 'children' => [ 'CreateAccount', 'DeleteAccount', 'ModifyAccountCheckPolicy', 'ModifyAccountDescription', 'ModifyPGHbaConfig', 'DescribeAccounts', 'DescribeInstanceKeywords', 'DescribePGHbaConfig', 'DescribeModifyPGHbaConfigLog', 'ResetAccountPassword', 'LockAccount', 'UnlockAccount', 'GrantAccountPrivilege', 'GrantOperatorPermission', 'RevokeOperatorPermission', 'RevokeAccountPrivilege', 'ResetAccount', 'CheckAccountNameAvailable', ], ], [ 'id' => 67378, 'title' => 'Database management', 'type' => 'directory', 'children' => [ 'CreateDatabase', 'DeleteDatabase', 'CopyDatabase', 'ModifyDBDescription', 'ModifyDatabaseConfig', 'ModifyCollationTimeZone', 'DescribeDatabases', 'DescribeCollationTimeZones', 'DescribeCharacterSetName', 'CopyDatabaseBetweenInstances', 'CheckDBNameAvailable', ], ], [ 'id' => 67393, 'title' => 'Read-Only Instances', 'type' => 'directory', 'children' => [ 'CreateReadOnlyDBInstance', 'ModifyReadonlyInstanceDelayReplicationTime', 'DescribeReadDBInstanceDelay', 'PrecheckDuckDBDependency', ], ], [ 'id' => 180085, 'title' => 'RDS Cluster Edition', 'type' => 'directory', 'children' => [ 'CreateDBNodes', 'CreateDBInstanceEndpoint', 'CreateDBInstanceEndpointAddress', 'DeleteDBNodes', 'DeleteDBInstanceEndpoint', 'DeleteDBInstanceEndpointAddress', 'ModifyDBNode', 'ModifyDBInstanceEndpoint', 'ModifyDBInstanceEndpointAddress', 'DescribeDBInstanceEndpoints', ], ], [ 'id' => 67403, 'title' => 'Dedicated proxy', 'type' => 'directory', 'children' => [ 'CreateDBProxyEndpointAddress', 'DeleteDBProxyEndpointAddress', 'ModifyDBProxy', 'UpgradeDBProxyInstanceKernelVersion', 'ModifyDBProxyInstance', 'ModifyDBProxyEndpoint', 'ModifyDBProxyEndpointAddress', 'ModifyDbProxyInstanceSsl', 'DescribeDBProxy', 'DescribeDBProxyEndpoint', 'DescribeDBProxyPerformance', 'GetDbProxyInstanceSsl', ], ], [ 'id' => 67397, 'title' => 'Shared proxy (phased-out)', 'type' => 'directory', 'children' => [ 'ModifyReadWriteSplittingConnection', 'DescribeDBInstanceProxyConfiguration', 'AllocateReadWriteSplittingConnection', 'ReleaseReadWriteSplittingConnection', 'CalculateDBInstanceWeight', ], ], [ 'id' => 67416, 'title' => 'Security management', 'type' => 'directory', 'children' => [ 'AttachWhitelistTemplateToInstance', 'CreateServiceLinkedRole', 'DetachWhitelistTemplateToInstance', 'ModifyWhitelistTemplate', 'DescribeSecurityGroupConfiguration', 'ModifySecurityGroupConfiguration', 'CreateDBInstanceSecurityGroupRule', 'DescribeDBInstanceSecurityGroupRule', 'ModifyDBInstanceSecurityGroupRule', 'DeleteDBInstanceSecurityGroupRule', 'ModifySecurityIps', 'ModifyDBInstanceSSL', 'ModifyDBInstanceTDE', 'ModifyDTCSecurityIpHostsForSQLServer', 'ModifyDBInstanceDeletionProtection', 'DescribeWhitelistTemplateLinkedInstance', 'DescribeInstanceLinkedWhitelistTemplate', 'DescribeWhitelistTemplate', 'DescribeAllWhitelistTemplate', 'DescribeDBInstanceIPArrayList', 'DescribeDBInstanceSSL', 'DescribeDBInstanceTDE', 'DescribeDBInstanceEncryptionKey', 'DescribeDBInstanceIpHostname', 'DescribeDTCSecurityIpHostsForSQLServer', 'MigrateSecurityIPMode', ], ], [ 'id' => 67429, 'title' => 'Log management', 'type' => 'directory', 'children' => [ 'DescribeSQLLogReportList', 'PurgeDBInstanceLog', 'DescribeSQLLogFiles', 'DescribeSlowLogs', 'DescribeSlowLogRecords', 'DescribeErrorLogs', 'ModifySQLCollectorPolicy', 'ModifySQLCollectorRetention', 'DescribeSQLCollectorPolicy', 'DescribeSQLLogRecords', 'DescribeSQLCollectorRetention', ], ], [ 'id' => 67443, 'title' => 'Backup and recovery', 'type' => 'directory', 'children' => [ 'ModifyBackupSetExpireTime', 'CreateBackup', 'DeleteBackup', 'DeleteBackupFile', 'ModifyBackupPolicy', 'DescribeBackups', 'DescribeDetachedBackups', 'DescribeBackupPolicy', 'DescribeBackupTasks', 'DescribeBinlogFiles', 'DescribeLogBackupFiles', 'DescribeBackupDatabase', ], ], [ 'id' => 67454, 'title' => 'Restoration', 'type' => 'directory', 'children' => [ 'CreateTempDBInstance', 'DescribeLocalAvailableRecoveryTime', 'DescribeMetaList', 'RecoveryDBInstance', 'CloneDBInstance', 'RestoreTable', ], ], [ 'id' => 67460, 'title' => 'Cross-region backup and restoration', 'type' => 'directory', 'children' => [ 'CreateDdrInstance', 'ModifyInstanceCrossBackupPolicy', 'DescribeInstanceCrossBackupPolicy', 'DescribeCrossBackupMetaList', 'DescribeCrossRegionBackups', 'DescribeCrossRegionLogBackupFiles', 'DescribeAvailableCrossRegion', 'DescribeAvailableRecoveryTime', 'DescribeCrossRegionBackupDBInstance', 'CheckCreateDdrDBInstance', 'RestoreDdrTable', ], ], [ 'id' => 67478, 'title' => 'Monitoring management', 'type' => 'directory', 'children' => [ 'ModifyDBInstanceMonitor', 'ModifyDBInstanceMetrics', 'DescribeResourceUsage', 'DescribeDBInstancePerformance', 'DescribeDBInstanceMonitor', 'DescribeAvailableMetrics', 'DescribeDBInstanceMetrics', ], ], [ 'id' => 67483, 'title' => 'Parameter management', 'type' => 'directory', 'children' => [ 'CreateParameterGroup', 'DeleteParameterGroup', 'ModifyParameter', 'ModifyParameterGroup', 'DescribeParameters', 'DescribeModifyParameterLog', 'DescribeParameterTemplates', 'DescribeParameterGroups', 'DescribeParameterGroup', 'CloneParameterGroup', ], ], [ 'id' => 67494, 'title' => 'Data migration', 'type' => 'directory', 'children' => [ 'DescibeImportsFromDatabase', ], ], [ 'id' => 181174, 'title' => 'Operation tasks', 'type' => 'directory', 'children' => [ 'ModifyActiveOperationTasks', 'DescribeActiveOperationTasks', 'CancelActiveOperationTasks', ], ], [ 'id' => 67281, 'title' => 'Migrate MySQL to the cloud', 'type' => 'directory', 'children' => [ 'DeleteUserBackupFile', 'UpdateUserBackupFile', 'ListUserBackupFiles', 'ImportUserBackupFile', ], ], [ 'id' => 67472, 'title' => 'Migrate SQL Server to the cloud', 'type' => 'directory', 'children' => [ 'CreateMigrateTask', 'CreateOnlineDatabaseTask', 'DescribeMigrateTasks', 'DescribeOssDownloads', 'DescribeMigrateTaskById', 'TerminateMigrateTask', ], ], [ 'id' => 180087, 'title' => 'SQL Server Active Directory (AD) domain', 'type' => 'directory', 'children' => [ 'DeleteADSetting', 'ModifyADInfo', 'DescribeADInfo', ], ], [ 'id' => 172818, 'title' => 'Cloud migration to an ApsaraDB RDS for PostgreSQL instance', 'type' => 'directory', 'children' => [ 'CreateCloudMigrationPrecheckTask', 'CreateCloudMigrationTask', 'DescribeCloudMigrationPrecheckResult', 'DescribeCloudMigrationResult', 'ActivateMigrationTargetInstance', ], ], [ 'id' => 180088, 'title' => 'Global active database cluster', 'type' => 'directory', 'children' => [ 'CreateGADInstance', 'CreateGadInstanceMember', 'DeleteGadInstance', 'DetachGadInstanceMember', 'DescribeGadInstances', 'ReceiveDBInstance', ], ], [ 'id' => 67504, 'title' => 'Tag management', 'type' => 'directory', 'children' => [ 'TagResources', 'AddTagsToResource', 'UntagResources', 'RemoveTagsFromResource', 'ListTagResources', 'DescribeTags', 'DescribeDBInstanceByTags', ], ], [ 'id' => 184280, 'title' => 'Extensions management', 'type' => 'directory', 'children' => [ 'CreatePostgresExtensions', 'DeletePostgresExtensions', 'UpdatePostgresExtensions', 'DescribePostgresExtensions', ], ], [ 'id' => 186806, 'title' => 'Manager Replication Solt on ApsaraDB RDS for PostgreSQL instance', 'type' => 'directory', 'children' => [ 'DeleteSlot', 'DescribeSlots', ], ], [ 'id' => 322281, 'title' => 'disaster recovery instance', 'type' => 'directory', 'children' => [ 'CreateReplicationLink', 'DescribeReplicationLinkLogs', 'RebuildReplicationLink', 'SwitchReplicationLink', 'DeleteReplicationLink', ], ], [ 'id' => 220823, 'title' => 'Assured Serverless', 'type' => 'directory', 'children' => [ 'ModifyComputeBurstConfig', 'DescribeComputeBurstConfig', ], ], [ 'id' => 180089, 'title' => 'Other APIs', 'type' => 'directory', 'children' => [ [ 'id' => 172816, 'title' => 'User secrets', 'type' => 'directory', 'children' => [ 'CreateSecret', 'DeleteSecret', 'DescribeSecrets', ], ], [ 'id' => 67312, 'title' => 'Dedicated cluster management', 'type' => 'directory', 'children' => [ 'DescribeDedicatedHostGroups', 'DescribeDedicatedHosts', 'MigrateDBInstance', 'RebuildDBInstance', ], ], 'MigrateConnectionToOtherZone', 'ModifyDBInstanceDelayedReplicationTime', 'CheckServiceLinkedRole', 'DescribeDBMiniEngineVersions', 'DescribeRegionInfos', 'DescribeDBInstanceNetInfoForChannel', 'DescribeHostWebShell', 'DescribeClassDetails', 'DescribeKmsAssociateResources', 'DescribeRCSnapshots', 'DetachRCDisk', 'DeleteRCSnapshot', 'CreateRCSnapshot', 'DescribeRCDisks', 'DeleteRCDisk', 'AttachRCDisk', 'DescribeRCClusterConfig', 'AttachRCInstances', 'DeleteRCClusterNodes', 'ModifyDBInstanceReplicationSwitch', 'DescribeDBInstanceReplication', 'MigrateDBNodes', 'SwitchOverMajorVersionUpgrade', 'AssociateEipAddressWithRCInstance', 'DescribeRCInstanceIpAddress', 'DescribeRCInstanceDdosCount', 'StopRCInstance', 'DeleteRCInstances', 'RunRCInstances', 'ModifyRCInstanceChargeType', 'StartRCInstance', 'DescribeRCInstanceAttribute', 'ResizeRCInstanceDisk', 'ModifyRCInstance', 'DeleteRCDeploymentSet', 'DescribeRCMetricList', 'DescribeRCInstances', 'DescribeRCImageList', 'ModifyRCInstanceDescription', 'CreateRCDisk', 'ReplaceRCInstanceSystemDisk', 'DescribeRCInstanceVncUrl', 'DescribeRCNodePool', 'CreateRCNodePool', 'RenewRCInstance', 'AuthorizeRCSecurityGroupPermission', ], ], [ 'id' => 195761, 'title' => 'Events and Tasks', 'type' => 'directory', 'children' => [ 'DescribeHistoryEventsStat', 'DescribeHistoryEvents', 'ModifyEventInfo', 'DescribeHistoryTasksStat', 'DescribeHistoryTasks', 'ModifyTaskInfo', 'DescribeTasks', ], ], [ 'id' => 187093, 'title' => 'Console Interface', 'type' => 'directory', 'children' => [ 'CreateYouhuiForOrder', 'DescribeCurrentModifyOrder', 'DescribeCustinsResourceInfo', 'DescribeDBInstanceConnectivity', 'DescribeHostGroupElasticStrategyParameters', 'DescribeMarketingActivity', 'DescribeQuickSaleConfig', 'DescribeResourceDetails', 'EvaluateLocalExtendDisk', 'ModifyCustinsResource', 'PreCheckCreateOrderForDeleteDBNodes', 'QueryRecommendByCode', 'CreateOrderForDeleteDBNodes', ], ], [ 'id' => 0, 'title' => 'Others', 'type' => 'directory', 'children' => [ 'DescribeSQLServerUpgradeVersions', 'DescribeActiveOperationMaintainConf', 'CreateMaskingRules', 'ModifyAccountMaskingPrivilege', 'ModifyMaskingRules', 'DescribeMaskingRules', 'DeleteMaskingRules', 'DescribeAccountMaskingPrivilege', 'DeleteParameterTimedScheduleTask', 'DescribeParameterTimedScheduleTask', 'ModifyParameterTimedScheduleTask', 'DescribeDBInstanceCLS', 'ModifyDBInstanceCLS', 'CreateRCImage', 'ModifyDBInstanceVectorSupportStatus', 'DescribeImportTaskValidation', 'DescribeImportTask', 'CreateImportTask', 'ValidateImportTask', 'ListImportTasks', 'ModifyImportTask', 'ModifyRCDiskAttribute', ], ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ 'TransformDBInstancePayType' => [ 'summary' => 'Changes the billing method of an ApsaraDB RDS instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxxxxx', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5xxxxxx', ], ], [ 'name' => 'UsedTime', 'in' => 'query', 'schema' => [ 'description' => 'The subscription duration of the instance. Valid values:'."\n" ."\n" .'* If you set **Period** to **Year**, the value of UsedTime ranges from **1 to 5**.'."\n" .'* If you set **Period** to **Month**, the value of UsedTime ranges from **1 to 11**.'."\n" ."\n" .'> This parameter must be specified when **PayType** is set to **Prepaid**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PayType', 'in' => 'query', 'schema' => [ 'description' => 'The new billing method of the instance. Valid values:'."\n" ."\n" .'* **Postpaid**: pay-as-you-go'."\n" .'* **Prepaid**: subscription'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Prepaid', ], ], [ 'name' => 'Period', 'in' => 'query', 'schema' => [ 'description' => 'The renewal cycle of the instance. Valid values:'."\n" ."\n" .'* **Year**'."\n" .'* **Month**'."\n" ."\n" .'> This parameter must be specified if you set **PayType** to **Prepaid**.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'Month', ], ], [ 'name' => 'BusinessInfo', 'in' => 'query', 'schema' => [ 'description' => 'The additional business information about the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'None'."\n", ], ], [ 'name' => 'AutoRenew', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable the auto-renewal feature for the instance. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n" ."\n" .'> - This parameter is valid only when you change the billing method from pay-as-you-go to subscription.'."\n" .'> - All strings except **true** are considered **false**.', 'type' => 'string', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'AutoUseCoupon', 'in' => 'query', 'schema' => [ 'type' => 'boolean', 'required' => false, 'description' => 'Specifies whether to use vouchers to offset fees. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false** (default)'."\n", 'example' => 'true', ], ], [ 'name' => 'PromotionCode', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, 'description' => 'The coupon code.'."\n", 'example' => '726702810223', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'DBInstanceId' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5xxxxxx', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '5E6E09DE-5B12-4BFF-A55E-1C86EDE06D9A', ], 'ExpiredTime' => [ 'description' => 'The expiration time.'."\n" ."\n" .'> If you call this operation to change the billing method of an instance from subscription to pay-as-you-go, this parameter is not returned.'."\n", 'type' => 'string', 'example' => '2020-04-20T10:00:00Z', ], 'OrderId' => [ 'description' => 'The order ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '205157600280623', ], 'ChargeType' => [ 'description' => 'The payment type.'."\n" ."\n" .'* Valid value if the new billing method is pay-as-you-go: POSTPAY'."\n" .'* Valid value if the new billing method is subscription: PREPAY'."\n", 'type' => 'string', 'example' => 'Prepaid', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The specified DB instance name does not exist.', ], [ 'errorCode' => 'InvalidInstanceUseType.NotSupport', 'errorMessage' => 'Specified instanceUseType does not support in RDS.', ], [ 'errorCode' => 'InvalidOrderCharge.NotSupport', 'errorMessage' => 'The specified order charge does not support in RDS.', ], [ 'errorCode' => 'InvalidOrderTask.NotSupport', 'errorMessage' => 'The Current InstanceId exist Order Task in RDS.', ], [ 'errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', ], [ 'errorCode' => 'IncompleteAccountInfo', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'IncompleteTaxInfo', 'errorMessage' => 'Your tax information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'InvalidPaymentMethod.Incomplete', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'InvalidPaymentMethod.Missing', 'errorMessage' => 'Your payment method is incomplete. We recommend that you add a payment method.', ], [ 'errorCode' => 'InsuffcientBalanceOrBankAccount', 'errorMessage' => 'Add a payment method or add funds to the prepayment balance. Get started by creating an instance.', ], [ 'errorCode' => 'InvalidPaymentMethod.NoAccess', 'errorMessage' => 'No payment method is specified for your account. Please contact your Customer Manager or open a ticket.', ], [ 'errorCode' => 'InvalidPaymentMethod.InsufficientBalance', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method or add funds to the prepayment balance.', ], [ 'errorCode' => 'OrderTaskAlreadyExists', 'errorMessage' => 'Order task already exists.', ], [ 'errorCode' => 'InvalidOldInstanceType.NotSupport', 'errorMessage' => 'Specified oldInstanceType does not support in RDS.', ], [ 'errorCode' => 'OperationDenied.TimeLimit', 'errorMessage' => 'The interval between the two conversion operations must be greater than 15 minutes.', ], [ 'errorCode' => 'InvalidDBInstanceId.Malformed', 'errorMessage' => 'The specified parameter DBInstanceId is not valid.', ], [ 'errorCode' => 'InvalidPayType.Malformed', 'errorMessage' => 'The specified parameter PayType is not valid.', ], [ 'errorCode' => 'InvalidResource.Format', 'errorMessage' => 'The specified parameter Resource is not valid.', ], [ 'errorCode' => 'InvalidPayType.Format', 'errorMessage' => 'The specified parameter PayType is not valid.', ], [ 'errorCode' => 'InvalidUsedTime.Format', 'errorMessage' => 'The specified parameter UsedTime is not valid.', ], [ 'errorCode' => 'InvalidPeriod.Format', 'errorMessage' => 'The specified parameter Period is not valid.', ], [ 'errorCode' => 'InvalidPeriodOrUsedTime.Format', 'errorMessage' => 'The specified parameter Period and UsedTime are not valid.', ], [ 'errorCode' => 'InvalidDiscountCoupon.Malformed', 'errorMessage' => 'The specified discount coupon is not valid.', ], [ 'errorCode' => 'InsufficientQuota.NoEnough', 'errorMessage' => 'Your current quota is insufficient. Please contact your channel partner to increase your quota.', ], [ 'errorCode' => 'SYSTEM.ILLEGALARGUMENT', 'errorMessage' => 'The current instance does not have a valid configuration when change the payType from Prepaid to Postpaid.', ], [ 'errorCode' => 'AccountMoneyValidate.error', 'errorMessage' => 'Insufficient funds available in the account.', ], [ 'errorCode' => 'ContainForbiddenLabel.error', 'errorMessage' => 'There is a label that prohibits placing an order, and the order cannot be placed.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'InvalidParam.PREPAY', 'errorMessage' => 'The prepaid instance purchase limit has been exceeded, and changing the payment method to prepaid is not allowed.', ], [ 'errorCode' => 'InvalidParam.POSTPAY', 'errorMessage' => 'It is not allowed to switch the payment method to postpaid after exceeding the purchase time limit for postpaid instances.', ], [ 'errorCode' => 'Order.InstHasUnsettledBills', 'errorMessage' => 'You currently have outstanding bills, please settle them first.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OperationDenied.LockMode', 'errorMessage' => 'The operation is not permitted when the instance locked.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DBInstanceId\\": \\"rm-uf6wjk5****\\",\\n \\"RequestId\\": \\"5E6E09DE-5B12-4BFF-A55E-1C86EDE06D9A\\",\\n \\"ExpiredTime\\": \\"2020-04-20T10:00:00Z\\",\\n \\"OrderId\\": 0,\\n \\"ChargeType\\": \\"POSTPAY\\"\\n}","type":"json"}]', 'title' => 'TransformDBInstancePayType', 'description' => '### Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" .'* MariaDB'."\n" ."\n" .'### References'."\n" ."\n" .'> Fees are generated if the call is successful. Before you call this operation, you must read the following documentation.'."\n" ."\n" .'* [Change the billing method of an ApsaraDB RDS for MySQL instance from pay-as-you-go to subscription](~~96048~~) or [Change the billing method of an ApsaraDB RDS for MySQL instance from subscription to pay-as-you-go](~~161875~~)'."\n" .'* [Change the billing method of an ApsaraDB RDS for PostgreSQL instance from pay-as-you-go to subscription](~~96743~~) or [Change the billing method of an ApsaraDB RDS for PostgreSQL instance from subscription to pay-as-you-go](~~162756~~)'."\n" .'* [Change the billing method of an ApsaraDB RDS for SQL Server instance from pay-as-you-go to subscription](~~95631~~) or [Change the billing method of an ApsaraDB RDS for SQL Server instance from subscription to pay-as-you-go](~~162755~~)'."\n" .'* [Change the billing method of an ApsaraDB RDS for MariaDB instance from pay-as-you-go to subscription](~~97120~~) or [Change the billing method of an ApsaraDB RDS for MariaDB instance from subscription to pay-as-you-go](~~169252~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ModifyDBInstancePayType' => [ 'summary' => 'Changes the billing method of an instance from pay-as-you-go to subscription.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => ' rm-bp1842vmucoa5w874', ], ], [ 'name' => 'UsedTime', 'in' => 'query', 'schema' => [ 'description' => 'The subscription duration of the instance. Valid values:'."\n" ."\n" .'* If you set the **Period** parameter to **Year**, the value of the **UsedTime** parameter ranges from 1 to 5.'."\n" .'* If you set the **Period** parameter to **Month**, the value of the **UsedTime** parameter ranges from 1 to 11.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', ], ], [ 'name' => 'PayType', 'in' => 'query', 'schema' => [ 'description' => 'The billing method of the instance. The value is fixed as **Prepaid**, which indicates the subscription billing method.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Prepaid', ], ], [ 'name' => 'Period', 'in' => 'query', 'schema' => [ 'description' => 'The renewal cycle of the instance.'."\n" ."\n" .'* **Year**'."\n" .'* **Month**'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Year', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'OrderId' => [ 'description' => 'The order ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '100789370230206', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'IncompleteAccountInfo', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'IncompleteTaxInfo', 'errorMessage' => ' Your tax information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'InvalidPaymentMethod.Incomplete', 'errorMessage' => ' No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'InvalidPaymentMethod.Missing', 'errorMessage' => ' Your payment method is incomplete. We recommend that you add a payment method.', ], [ 'errorCode' => 'InsuffcientBalanceOrBankAccount', 'errorMessage' => 'Add a payment method or add funds to the prepayment balance. Get started by creating an instance.', ], [ 'errorCode' => 'InvalidPaymentMethod.NoAccess', 'errorMessage' => 'No payment method is specified for your account. Please contact your Customer Manager or open a ticket.', ], [ 'errorCode' => 'InvalidPaymentMethod.InsufficientBalance', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method or add funds to the prepayment balance.', ], [ 'errorCode' => 'OrderTaskAlreadyExists', 'errorMessage' => 'Order task already exists.', ], [ 'errorCode' => 'ReadOnlyInstanceNotSupport', 'errorMessage' => 'Specified ReadOnly Instance not support this operation.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'InvalidParam.POSTPAY', 'errorMessage' => 'It is not allowed to switch the payment method to postpaid after exceeding the purchase time limit for postpaid instances.', ], [ 'errorCode' => 'InvalidParam.PREPAY', 'errorMessage' => 'The prepaid instance purchase limit has been exceeded, and changing the payment method to prepaid is not allowed.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OrderId\\": 0\\n}","type":"json"}]', 'title' => 'ModifyDBInstancePayType', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" .'* MariaDB'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> Fees of an instance are changed if the call is successful. Before you call this operation, carefully read the following topics:'."\n" ."\n" .'* [Change the billing method of an ApsaraDB RDS for MySQL instance from pay-as-you-go to subscription](~~96048~~)'."\n" .'* [Change the billing method of an ApsaraDB RDS for PostgreSQL instance from pay-as-you-go to subscription](~~96743~~)'."\n" .'* [Change the billing method of an ApsaraDB RDS for SQL Server instance from pay-as-you-go to subscription](~~95631~~)'."\n" .'* [Change the billing method of an ApsaraDB RDS for MariaDB instance from pay-as-you-go to subscription](~~97120~~)'."\n", ], 'ModifyInstanceAutoRenewalAttribute' => [ 'summary' => 'Modifies the auto-renewal settings of an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCzxxxxxx', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-bpxxxxx', ], ], [ 'name' => 'Duration', 'in' => 'query', 'schema' => [ 'description' => 'The number of months for auto-renewal. Valid values: **1 to 12**.'."\n" ."\n" .'> This parameter must be specified when **AutoRenew** is set to **True**.'."\n", 'type' => 'string', 'required' => false, 'example' => '2', ], ], [ 'name' => 'AutoRenew', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable auto-renewal. Valid values:'."\n" ."\n" .'* **True**'."\n" .'* **False**'."\n", 'type' => 'string', 'required' => false, 'example' => 'True', 'default' => 'False', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"7463B73D-35CC-4D19-A010-6B8D65D242EF\\",\\n \\"HostId\\": \\"rds.aliyuncs.com\\",\\n \\"Code\\": \\"UnsupportedOperation\\",\\n \\"Message\\": \\"The specified action is not supported.\\"\\n}"},{"type":"xml","example":"\\r\\n1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC\\r\\n","errorExample":""}]', 'title' => 'ModifyInstanceAutoRenewalAttribute', 'description' => '### Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" .'* MariaDB'."\n" ."\n" .'### References'."\n" .'>Fees are generated if the call is successful. Before you call this operation, carefully read the following topics:>'."\n" ."\n" .'* [Use the auto-renewal feature for an ApsaraDB RDS for MySQL instance](~~96049~~)'."\n" .'* [Use the auto-renewal feature for an ApsaraDB RDS for PostgreSQL instance](~~96740~~)'."\n" .'* [Use the auto-renewal feature for an ApsaraDB RDS for SQL Server instance](~~95635~~)'."\n" .'* [Use the auto-renewal feature for an ApsaraDB RDS for MariaDB instance](~~97121~~)', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribePrice' => [ 'summary' => 'Queries the price of an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCz*****', ], ], [ 'name' => 'CommodityCode', 'in' => 'query', 'schema' => [ 'description' => 'The commodity code of the instance. Valid values:'."\n" ."\n" .'* **bards**: The instance is a pay-as-you-go primary instance. This value is available at the China site (aliyun.com).'."\n" .'* **rds** (default): The instance is a subscription primary instance. This value is available at the China site (aliyun.com).'."\n" .'* **rords**: The instance is a pay-as-you-go read-only instance. This value is available at the China site (aliyun.com).'."\n" .'* **rds_rordspre_public_cn**: The instance is a subscription read-only instance. This value is available at the China site (aliyun.com).'."\n" .'* **bards_intl**: The instance is a pay-as-you-go primary instance. This value is available at the international site (alibabacloud.com).'."\n" .'* **rds_intl**: The instance is a subscription primary instance. This value is available at the international site (alibabacloud.com).'."\n" .'* **rords_intl**: The instance is a pay-as-you-go read-only instance. This value is available at the international site (alibabacloud.com).'."\n" .'* **rds_rordspre_public_intl**: The instance is a subscription read-only instance. This value is available at the international site (alibabacloud.com).'."\n" ."\n" .'> If you want to query the price of a read-only instance, you must specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rds', 'default' => 'rds', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'Engine', 'in' => 'query', 'schema' => [ 'description' => 'The database engine of the instance. Valid values:'."\n" ."\n" .'* **MySQL**'."\n" .'* **SQLServer**'."\n" .'* **PostgreSQL**'."\n" .'* **MariaDB**'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MySQL', ], ], [ 'name' => 'EngineVersion', 'in' => 'query', 'schema' => [ 'description' => 'The database engine version of the instance. Valid values:'."\n" ."\n" .'* Valid values if you set Engine to **MySQL**: **5.5**, **5.6**, **5.7**, and **8.0**'."\n" .'* Valid values if you set Engine to **SQL Server**: **08r2\\_ent_ha**(cloud disks, discontinued), **2008r2**(high-performance local disks, discontinued), **2012** (SQL Server EE Basic)**2012\\_ent_ha**, **2012\\_std_ha**, **2012\\_web**, **2016\\_ent_ha**, **2016\\_std_ha**, **2016\\_web**, **2017\\_ent**, **2017\\_std_ha**, **2017\\_web**, **2019\\_ent**, **2019\\_std_ha**, **2019\\_web**, **2022\\_ent**, **2022\\_std_ha**, and **2022\\_web**'."\n" .'* Valid values if you set Engine to **PostgreSQL**: **10.0**, **11.0**, **12.0**, **13.0**, **14.0**, and **15.0**'."\n" .'* Valid value if you set Engine to **MariaDB**: **10.3**'."\n" ."\n" .'> The following information describes the valid values when you set Engine to SQLServer: `_ent` specifies SQL Server EE on RDS Cluster Edition, `_ent_ha` specifies SQL Server EE, `_std_ha` specifies SQL Server SE, and `_web` specifies SQL Server Web.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '5.5', ], ], [ 'name' => 'DBInstanceClass', 'in' => 'query', 'schema' => [ 'description' => 'The instance type of the instance. For more information, see [Primary ApsaraDB RDS instance types](~~26312~~).'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rds.mysql.s1.small', ], ], [ 'name' => 'DBInstanceStorage', 'in' => 'query', 'schema' => [ 'description' => 'The storage capacity of the instance. Unit: GB. You can increase the storage capacity at a step size of 5 GB. For more information, see [Primary ApsaraDB RDS instance types](~~26312~~).'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '20', ], ], [ 'name' => 'PayType', 'in' => 'query', 'schema' => [ 'description' => 'The billing method of the instance. Valid values:'."\n" ."\n" .'* **Prepaid**: subscription'."\n" .'* **Postpaid**: pay-as-you-go'."\n", 'type' => 'string', 'required' => false, 'example' => 'Prepaid', ], ], [ 'name' => 'ZoneId', 'in' => 'query', 'schema' => [ 'description' => 'The zone ID of the primary instance. You can call the DescribeRegions operation to query the most recent zone list.'."\n" ."\n" .'> If you specify a virtual private cloud (VPC) and a vSwitch, this parameter is required to identify the zone for the vSwitch.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-b', ], ], [ 'name' => 'UsedTime', 'in' => 'query', 'schema' => [ 'description' => 'The subscription duration of the instance.'."\n" ."\n" .'* If you set the **TimeType** parameter to **Year**, the value of the UsedTime parameter ranges from **1 to 100**.'."\n" .'* If you set the **TimeType** parameter to **Month**, the value of the UsedTime parameter ranges from **1 to 999**.'."\n" ."\n" .'Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '999', 'minimum' => '1', 'example' => '1', 'default' => '1', ], ], [ 'name' => 'TimeType', 'in' => 'query', 'schema' => [ 'description' => 'The billing cycle of the subscription instance. This parameter is required when **CommodityCode** is set to **rds**, **rds_rordspre_public_cn**, **rds_intl**, or **rds_rordspre_public_intl**. Valid values:'."\n" ."\n" .'* **Year**'."\n" .'* **Month**'."\n", 'type' => 'string', 'required' => false, 'enumValueTitles' => [], 'example' => 'Year', 'default' => 'Hour', 'enum' => [ 'Year', 'Month', 'Day', 'Hour', ], ], ], [ 'name' => 'Quantity', 'in' => 'query', 'schema' => [ 'description' => 'The number of instances that you want to purchase. Valid values: **0 to 30**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10', ], ], [ 'name' => 'InstanceUsedType', 'in' => 'query', 'schema' => [ 'description' => 'The role of the instance. Valid values:'."\n" ."\n" .'* **0**: primary instance'."\n" .'* **3**: read-only instance'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], ], [ 'name' => 'OrderType', 'in' => 'query', 'schema' => [ 'description' => 'The order type. Valid values:'."\n" ."\n" .'* **BUY**'."\n" .'* **RENEW**'."\n" .'* **UPGRADE**'."\n" .'* **DOWNGRADE**'."\n", 'type' => 'string', 'required' => false, 'example' => 'BUY', 'default' => 'BUY', ], ], [ 'name' => 'DBInstanceStorageType', 'in' => 'query', 'schema' => [ 'description' => 'The storage type of the new instance. Valid values:'."\n" ."\n" .'* **general_essd**: premium Enterprise SSD (ESSD)'."\n" .'* **local_ssd**: premium local SSD'."\n" .'* **cloud_ssd**: standard SSD'."\n" .'* **cloud_essd**: performance level 1 (PL1) ESSD'."\n" .'* **cloud_essd2**: PL2 ESSD'."\n" .'* **cloud_essd3**: PL3 ESSD'."\n", 'type' => 'string', 'required' => false, 'example' => 'local_ssd', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the instance for which you want to change the specifications or the instance that you want to renew.'."\n" ."\n" .'> * If you want to query the price of a specification change order or a renewal order, you must specify this parameter.'."\n" .'> * If the instance is a read-only instance, you must set this parameter to the ID of its primary instance.', 'type' => 'string', 'required' => false, 'example' => 'rm-*****', ], ], [ 'name' => 'DBNode', 'in' => 'query', 'allowEmptyValue' => true, 'style' => 'json', 'schema' => [ 'description' => 'The information about the node.'."\n" ."\n" .'> This parameter is supported for ApsaraDB RDS for MySQL instances that run RDS Cluster Edition.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details of the node.'."\n", 'type' => 'object', 'properties' => [ 'ClassCode' => [ 'description' => 'The instance type of the node.'."\n", 'type' => 'string', 'required' => false, 'example' => 'mysql.n2.small.xc', ], 'ZoneId' => [ 'description' => 'The zone ID of the node.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-j', ], ], 'required' => false, ], 'required' => false, ], ], [ 'name' => 'ServerlessConfig', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The settings of the serverless instance.'."\n" ."\n" .'> ApsaraDB RDS for MariaDB does not support serverless instances.'."\n", 'type' => 'object', 'properties' => [ 'MaxCapacity' => [ 'description' => 'The maximum number of RDS Capacity Units (RCUs).'."\n", 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '8', ], 'MinCapacity' => [ 'description' => 'The minimum number of RCUs.'."\n", 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '0.5', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'OrderParams' => [ 'description' => 'The order parameters.'."\n" ."\n" .'> If the **OrderParamOut** parameter is set to **true**, the value of the OrderParams parameter is returned.'."\n", 'type' => 'string', 'example' => '{\\"autoPay\\":false}"'."\n", ], 'PriceInfo' => [ 'description' => 'The price information.'."\n", 'type' => 'object', 'properties' => [ 'ActivityInfo' => [ 'description' => 'The information about the promotion.'."\n", 'type' => 'object', 'properties' => [ 'CheckErrMsg' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'Error description', ], 'ErrorCode' => [ 'description' => 'The error code that is returned.'."\n", 'type' => 'string', 'example' => ' 123456', ], 'Success' => [ 'description' => 'Indicates whether the request was successful.'."\n", 'type' => 'string', 'example' => 'Success', ], ], ], 'Coupons' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Coupon' => [ 'description' => 'The information about the coupon.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the coupon.'."\n", 'type' => 'object', 'properties' => [ 'CouponNo' => [ 'description' => 'The coupon ID.'."\n", 'type' => 'string', 'example' => '123456', ], 'Description' => [ 'description' => 'The description of the coupon.'."\n", 'type' => 'string', 'example' => 'test', ], 'IsSelected' => [ 'description' => 'Indicates whether the coupon is selected.'."\n", 'type' => 'string', 'example' => 'true', ], 'Name' => [ 'description' => 'The coupon name.'."\n", 'type' => 'string', 'example' => 'test', ], ], ], ], ], ], 'Currency' => [ 'description' => 'The currency unit.'."\n", 'type' => 'string', 'example' => 'CNY', ], 'DiscountPrice' => [ 'description' => 'The discount.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '0', ], 'OrderLines' => [ 'description' => 'The order information.'."\n", 'type' => 'any', 'example' => 'Order Information', ], 'OriginalPrice' => [ 'description' => 'The original price.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '2504', ], 'RuleIds' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'RuleId' => [ 'description' => 'An array that consists of the ID of the promotion rule.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The ID of the promotion rule.'."\n", 'type' => 'string', 'example' => '1001199213', ], ], ], ], 'TradeMaxRCUAmount' => [ 'description' => 'The estimated hourly cost that is calculated based on the maximum number of RCUs you specify.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '1**', ], 'TradeMinRCUAmount' => [ 'description' => 'The estimated hourly cost that is calculated based on the minimum number of RCUs you specify.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '2**', ], 'TradePrice' => [ 'description' => 'The transaction price, which is equal to the original price minus the discount.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '2504', ], ], ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'CA0ADDDC-0BEB-4381-A3ED-73B4C79B8CC6', ], 'Rules' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Rule' => [ 'description' => 'The details of the promotion rule.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details of the promotion rule.'."\n", 'type' => 'object', 'properties' => [ 'Description' => [ 'description' => 'The description of the promotion rule.'."\n", 'type' => 'string', 'example' => 'Activity Description', ], 'Name' => [ 'description' => 'The name of the promotion rule.'."\n", 'type' => 'string', 'example' => 'Rule1', ], 'RuleId' => [ 'description' => 'The ID of the promotion rule.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1020021003939076', ], ], ], ], ], ], 'ServerlessPrice' => [ 'description' => 'The pricing information about a serverless RDS instance.'."\n", 'type' => 'object', 'properties' => [ 'RCUDiscountMaxAmount' => [ 'description' => 'The discount amount of the maximum number of RCUs.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '1**.*', ], 'RCUDiscountMinAmount' => [ 'description' => 'The discount amount of the minimum number of RCUs.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '1*.*', ], 'RCUOriginalMaxAmount' => [ 'description' => 'The price of the maximum number of RCUs.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '2**.*', ], 'RCUOriginalMinAmount' => [ 'description' => 'The price of the minimum number of RCUs.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '3*.*', ], 'StorageOriginalAmount' => [ 'description' => 'The original price of the disk capacity.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '1*', ], 'TotalOriginalMaxAmount' => [ 'description' => 'The maximum total price before the discount.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '2**.*', ], 'TotalOriginalMinAmount' => [ 'description' => 'The minimum total price before the discount.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '2*.*', ], 'TradeMaxRCUAmount' => [ 'description' => 'The transaction price of the maximum number of RCUs.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '1**.*', ], 'TradeMinRCUAmount' => [ 'description' => 'The transaction price of the minimum number of RCUs.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '2*.*', ], 'storageDiscountAmount' => [ 'description' => 'The discounted price of the disk capacity.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '2.*', ], ], ], 'ShowDiscount' => [ 'description' => 'Indicates whether discounts can be used.'."\n", 'type' => 'boolean', 'example' => 'True', ], 'TradeMaxRCUAmount' => [ 'description' => 'The estimated hourly fee that is calculated based on the maximum number of RCUs.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '2**', ], 'TradeMinRCUAmount' => [ 'description' => 'The estimated hourly fee that is calculated based on the minimum number of RCUs.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '1**', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'DBInstanceStorageFormatFault', 'errorMessage' => 'DBInstanceStorageFormatFault', ], [ 'errorCode' => 'InvalidDBInstanceStorage.Format', 'errorMessage' => 'InvalidDBInstanceStorage.Format', ], [ 'errorCode' => 'DBNodeParameter.InvalidClassCode', 'errorMessage' => 'The ClassCode of the item of the specified parameter DBNode is inconsistent.', ], [ 'errorCode' => 'Price.WanHuaTong.sys', 'errorMessage' => 'Inquiry error.', ], [ 'errorCode' => 'SYSTEM.SaleValidateFailed', 'errorMessage' => 'The request not refer to the correct order period. please check your Period or UsedTime param.', ], [ 'errorCode' => 'Price.HsfTimeoutError', 'errorMessage' => 'Inquiry error.', ], [ 'errorCode' => 'Rule.HsfTimeoutError', 'errorMessage' => 'Request rule service error.', ], [ 'errorCode' => 'InvalidDBInstanceClassNotFound', 'errorMessage' => 'Specified DB instance class is not found.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'DBNodeFormatFault', 'errorMessage' => 'The specified parameter DBNode is malformed', ], [ 'errorCode' => 'DBNodeParameter.Required', 'errorMessage' => 'The DBNode parameter is required for RDS for MySQL Cluster Edition instances.', ], [ 'errorCode' => 'DBNodeParameter.TooFewItems', 'errorMessage' => 'You must configure at least 2 nodes in the DBNode parameter value for RDS for MySQL Cluster Edition instances.', ], [ 'errorCode' => 'DBNodeParameter.TooManyItems', 'errorMessage' => 'You can configure up to 9 nodes in the DBNode parameter value for RDS for MySQL Cluster Edition instances.', ], ], 403 => [ [ 'errorCode' => 'CASH.BOOK.INSUFFICIENT', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method or maitain a minimum prepayment balance of INR 1000.', ], [ 'errorCode' => 'RegionDissolvedInduEOFS', 'errorMessage' => 'Alibaba Cloud plans to optimize and adjust the region in India. Cloud services in this region will stop operating. you are currently unable to operate new purchase, renewal, and configuration change orders.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidTimeType.NotFound', 'errorMessage' => 'The parameter timeType does not exist.', ], [ 'errorCode' => 'canNotFindSubscription', 'errorMessage' => 'Subscription information not found.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"OrderParams\\": \\"{\\\\\\\\\\\\\\"autoPay\\\\\\\\\\\\\\":false}\\\\\\"\\\\n\\",\\n \\"PriceInfo\\": {\\n \\"ActivityInfo\\": {\\n \\"CheckErrMsg\\": \\"Error description\\",\\n \\"ErrorCode\\": \\" 123456\\",\\n \\"Success\\": \\"Success\\"\\n },\\n \\"Coupons\\": {\\n \\"Coupon\\": [\\n {\\n \\"CouponNo\\": \\"123456\\",\\n \\"Description\\": \\"test\\",\\n \\"IsSelected\\": \\"true\\",\\n \\"Name\\": \\"test\\"\\n }\\n ]\\n },\\n \\"Currency\\": \\"CNY\\",\\n \\"DiscountPrice\\": 0,\\n \\"OrderLines\\": \\"Order Information\\",\\n \\"OriginalPrice\\": 10508,\\n \\"RuleIds\\": {\\n \\"RuleId\\": [\\n \\"100119****\\"\\n ]\\n },\\n \\"TradeMaxRCUAmount\\": 0,\\n \\"TradeMinRCUAmount\\": 0,\\n \\"TradePrice\\": 10508\\n },\\n \\"RequestId\\": \\"CA0ADDDC-0BEB-4381-A3ED-73B4C79B8CC6\\",\\n \\"Rules\\": {\\n \\"Rule\\": [\\n {\\n \\"Description\\": \\"Activity Description\\",\\n \\"Name\\": \\"Rule1\\",\\n \\"RuleId\\": 0\\n }\\n ]\\n },\\n \\"ServerlessPrice\\": {\\n \\"RCUDiscountMaxAmount\\": 0,\\n \\"RCUDiscountMinAmount\\": 0,\\n \\"RCUOriginalMaxAmount\\": 0,\\n \\"RCUOriginalMinAmount\\": 0,\\n \\"StorageOriginalAmount\\": 0,\\n \\"TotalOriginalMaxAmount\\": 0,\\n \\"TotalOriginalMinAmount\\": 0,\\n \\"TradeMaxRCUAmount\\": 0,\\n \\"TradeMinRCUAmount\\": 0,\\n \\"storageDiscountAmount\\": 0\\n },\\n \\"ShowDiscount\\": true,\\n \\"TradeMaxRCUAmount\\": 0,\\n \\"TradeMinRCUAmount\\": 0\\n}","errorExample":""},{"type":"xml","example":"\\n CA0ADDDC-0BEB-4381-A3ED-73B4C79B8CC6\\n \\n 2504\\n 0\\n CNY\\n 2504\\n \\n true\\n 123456\\n test\\n test\\n \\n 1001199213\\n \\n Error description\\n 123456\\n Success\\n \\n \\n \\n Rule1\\n Activity Description\\n 1020021003939076\\n \\n","errorExample":""}]', 'title' => 'DescribePrice', 'description' => '### Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" .'* MariaDB'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeRenewalPrice' => [ 'summary' => 'Queries the renewal fees for a subscription instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxxxxx', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5xxxxxx', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'PayType', 'in' => 'query', 'schema' => [ 'description' => 'The billing method of the instance. Valid values:'."\n" ."\n" .'* **Postpaid**: pay-as-you-go'."\n" .'* **Prepaid**: subscription'."\n", 'type' => 'string', 'required' => false, 'example' => 'Postpaid', 'default' => 'Prepaid', ], ], [ 'name' => 'DBInstanceClass', 'in' => 'query', 'schema' => [ 'description' => 'The instance type of the instance. For more information, see [Primary instance types](~~26312~~). By default, the current instance type applies.'."\n", 'type' => 'string', 'required' => false, 'example' => 'mysql.n2.medium.2c', ], ], [ 'name' => 'UsedTime', 'in' => 'query', 'schema' => [ 'description' => 'The subscription duration of the instance. Valid values:'."\n" ."\n" .'* If you set the **TimeType** parameter to **Year**, the value of the UsedTime parameter is within the range of **1 to 3**.'."\n" .'* If you set the **TimeType** parameter to **Month**, the value of the UsedTime parameter is within the range of **1 to 9**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', ], ], [ 'name' => 'TimeType', 'in' => 'query', 'schema' => [ 'description' => 'The renewal cycle of the instance. Valid values:'."\n" ."\n" .'* **Year**'."\n" .'* **Month**'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Year', ], ], [ 'name' => 'Quantity', 'in' => 'query', 'schema' => [ 'description' => 'The number of the instances. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1', ], ], [ 'name' => 'OrderType', 'in' => 'query', 'schema' => [ 'description' => 'The type of order. Set the value to **BUY**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'BUY', 'default' => 'RENEW', ], ], [ 'name' => 'BusinessInfo', 'in' => 'query', 'schema' => [ 'description' => 'The additional business information about the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => '121436975448952', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The resource group ID. You can call the DescribeDBInstanceAttribute operation to query the resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmx****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'PriceInfo' => [ 'description' => 'Details of price information.'."\n", 'type' => 'object', 'properties' => [ 'ActivityInfo' => [ 'description' => 'The information about the promotion.'."\n", 'type' => 'object', 'properties' => [ 'CheckErrMsg' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'Error description'."\n", ], 'ErrorCode' => [ 'description' => 'The error code that is returned.'."\n", 'type' => 'string', 'example' => ' 123456', ], 'Success' => [ 'description' => 'Indicates whether the request was successful.'."\n", 'type' => 'string', 'example' => 'Success', ], ], ], 'Coupons' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Coupon' => [ 'description' => 'An array that consists of information about the coupon.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details of the coupon.'."\n", 'type' => 'object', 'properties' => [ 'CouponNo' => [ 'description' => 'The coupon ID.'."\n", 'type' => 'string', 'example' => '123456', ], 'Description' => [ 'description' => 'The description of the coupon.'."\n", 'type' => 'string', 'example' => 'test', ], 'IsSelected' => [ 'description' => 'Indicates whether the coupon is selected.'."\n", 'type' => 'string', 'example' => 'true', ], 'Name' => [ 'description' => 'The name of the coupon.'."\n", 'type' => 'string', 'example' => 'test', ], ], ], ], ], ], 'Currency' => [ 'description' => 'The currency unit.'."\n", 'type' => 'string', 'example' => 'CNY', ], 'DiscountPrice' => [ 'description' => 'The discount.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '27', ], 'OriginalPrice' => [ 'description' => 'The original price.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '138', ], 'RuleIds' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'RuleId' => [ 'description' => 'An array that consists of the ID of the promotion rule.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The ID of the promotion rule.'."\n", 'type' => 'string', 'example' => '1001199213', ], ], ], ], 'TradePrice' => [ 'description' => 'The transaction price, which is equal to the original price minus the discount.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '111', ], ], ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'DC9F4EF6-D038-4405-B497-1F48E722C9F2', ], 'Rules' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Rule' => [ 'description' => 'An array that consists of the details of the promotion rule.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details of the promotion rule.'."\n", 'type' => 'object', 'properties' => [ 'Description' => [ 'description' => 'The description of the activity.'."\n", 'type' => 'string', 'example' => 'Content'."\n", ], 'Name' => [ 'description' => 'The name of the rule.'."\n", 'type' => 'string', 'example' => 'test', ], 'RuleId' => [ 'description' => 'The ID of the promotion rule.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1001199213', ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'SYSTEM.SaleValidateFailed', 'errorMessage' => 'The request not refer to the correct order period. please check your Period or UsedTime param.', ], [ 'errorCode' => 'OrdQueryAccountError', 'errorMessage' => 'Error calling account service.', ], [ 'errorCode' => 'Price.WanHuaTong.sys', 'errorMessage' => 'Inquiry error.', ], [ 'errorCode' => 'DBNodeParameter.Required', 'errorMessage' => 'The specified parameter DBNode is required.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'canNotFindSubscription', 'errorMessage' => 'Subscription information not found.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"PriceInfo\\": {\\n \\"ActivityInfo\\": {\\n \\"CheckErrMsg\\": \\"Error description\\",\\n \\"ErrorCode\\": \\" 123456\\",\\n \\"Success\\": \\"Success\\"\\n },\\n \\"Coupons\\": {\\n \\"Coupon\\": [\\n {\\n \\"CouponNo\\": \\"123456\\",\\n \\"Description\\": \\"test\\",\\n \\"IsSelected\\": \\"true\\",\\n \\"Name\\": \\"test\\"\\n }\\n ]\\n },\\n \\"Currency\\": \\"CNY\\",\\n \\"DiscountPrice\\": 27,\\n \\"OriginalPrice\\": 138,\\n \\"RuleIds\\": {\\n \\"RuleId\\": [\\n \\"1001199213\\"\\n ]\\n },\\n \\"TradePrice\\": 111\\n },\\n \\"RequestId\\": \\"DC9F4EF6-D038-4405-B497-1F48E722C9F2\\",\\n \\"Rules\\": {\\n \\"Rule\\": [\\n {\\n \\"Description\\": \\"Activity Description\\",\\n \\"Name\\": \\"test\\",\\n \\"RuleId\\": 1001199213\\n }\\n ]\\n }\\n}","errorExample":"{\\n \\"RequestId\\": \\"7463B73D-35CC-4D19-A010-6B8D65D242EF\\",\\n \\"HostId\\": \\"rds.aliyuncs.com\\",\\n \\"Code\\": \\"UnsupportedOperation\\",\\n \\"Message\\": \\"The specified action is not supported.\\"\\n}"},{"type":"xml","example":"\\nBA34B8E6-4119-49B0-BDA3-6ECD9B097A98\\n\\n \\n 1020021003939076\\n test\\n \\n\\n\\n 1070\\n CNY\\n 1070\\n \\n 1020021003939076\\n \\n 0\\n \\n \\n\\n","errorExample":""}]', 'title' => 'DescribeRenewalPrice', 'description' => '### Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" .'* MariaDB'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeInstanceAutoRenewalAttribute' => [ 'summary' => 'Queries the automatic renewal status of an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxx', ], ], [ 'name' => 'proxyId', 'in' => 'query', 'schema' => [ 'description' => 'This parameter is reserved. You do not need to specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'API', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rm-bpxxxxxxx', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page. Valid values:'."\n" ."\n" .'* **30 (default value)**'."\n" .'* **50**'."\n" .'* **100**'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '30', 'example' => '30', 'default' => '30', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '50', 'minimum' => '1', 'example' => '1', 'default' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Items' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Item' => [ 'description' => 'The renewal information about the instance.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'AutoRenew' => [ 'description' => 'Indicates whether to enable auto-renewal for the instance.'."\n", 'type' => 'string', 'example' => 'True', ], 'DBInstanceId' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-bpxxxxxxx', ], 'Duration' => [ 'description' => 'The renewal period.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RegionId' => [ 'description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], 'Status' => [ 'description' => 'The instance status.'."\n", 'type' => 'string', 'example' => 'Normal', ], ], ], ], ], ], 'PageNumber' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageRecordCount' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '4182309D-CD29-49B1-B4A5-D7CB4D56C31F', ], 'TotalRecordCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Items\\": {\\n \\"Item\\": [\\n {\\n \\"AutoRenew\\": \\"True\\",\\n \\"DBInstanceId\\": \\"rm-bp****\\",\\n \\"Duration\\": 1,\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Status\\": \\"Normal\\"\\n }\\n ]\\n },\\n \\"PageNumber\\": 1,\\n \\"PageRecordCount\\": 1,\\n \\"RequestId\\": \\"4182309D-CD29-49B1-B4A5-D7CB4D56C31F\\",\\n \\"TotalRecordCount\\": 1\\n}","errorExample":"{\\n \\"RequestId\\": \\"7463B73D-35CC-4D19-A010-6B8D65D242EF\\",\\n \\"HostId\\": \\"rds.aliyuncs.com\\",\\n \\"Code\\": \\"UnsupportedOperation\\",\\n \\"Message\\": \\"The specified action is not supported.\\"\\n}"},{"type":"xml","example":"\\n\\n \\n Normal\\n 0\\n cn-hangzhou\\n rm-uf6wjk5xxxxxx\\n \\n\\n1\\n8AF3C49A-9E5F-448F-9C67-E04C7DED2B97\\n1\\n","errorExample":""}]', 'title' => 'DescribeInstanceAutoRenewalAttribute', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" .'* MariaDB'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'RenewInstance' => [ 'summary' => 'Manually renews an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the generated token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxxxxx', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5xxxxxxxxxx', ], ], [ 'name' => 'Period', 'in' => 'query', 'schema' => [ 'description' => 'The duration of the subscription renewal. Unit: month. Valid values:'."\n" ."\n" .'* **1~9**'."\n" .'* **12**'."\n" .'* **24**'."\n" .'* **36**'."\n" .'* **48**'."\n" .'* **60**'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '12', ], ], [ 'name' => 'AutoPay', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable automatic payment during the renewal. Valid values:'."\n" ."\n" .'* **True**: enables automatic payment. Make sure that your Alibaba Cloud account has adequate balance.'."\n" .'* **False** (default): disables automatic payment. You have to manually pay the order in the console.'."\n" ."\n" .'> For more information about how to renew the instance in the console, see the following topics:'."\n" ."\n" .'* [Manually renew an ApsaraDB RDS for MySQL instance](~~96050~~)'."\n" ."\n" .'* [Manually renew an ApsaraDB RDS for PostgreSQL instance](~~96741~~)'."\n" ."\n" .'* [Manually renew an ApsaraDB RDS for SQL Server instance](~~95637~~)'."\n" ."\n" .'* [Manually renew an ApsaraDB RDS for MariaDB instance](~~97122~~)'."\n", 'type' => 'string', 'required' => false, 'example' => 'True', 'default' => 'False', ], ], [ 'name' => 'AutoRenew', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable auto-renewal for the instance. Valid values:'."\n" ."\n" .'* **true**.'."\n" .'* **false** (default)'."\n", 'type' => 'string', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'AutoUseCoupon', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to use a coupon. Valid values:'."\n" ."\n" .'* **true**: uses a coupon.'."\n" .'* **false** (default): does not use a coupon.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'PromotionCode', 'in' => 'query', 'schema' => [ 'description' => 'The coupon code.'."\n", 'type' => 'string', 'required' => false, 'example' => '726702810223', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'OrderId' => [ 'description' => 'The order ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '201815745430941', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF ', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidConcurrentOperate', 'errorMessage' => 'Concurrent operation is detected.', ], [ 'errorCode' => 'ArrearageOrderExists', 'errorMessage' => 'Your account has an outstanding balance.', ], [ 'errorCode' => 'OperationDenied.MultiRegions', 'errorMessage' => 'Specified operation dose not support multiple regions.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'Cloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'InvalidParam.UsedTime', 'errorMessage' => 'The renewal expiration date cannot exceed:%s.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'StopService.Renew', 'errorMessage' => 'The service has been discontinued and renewal operations for instances on the classic network are no longer allowed.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidOrderCharge.NotSupport', 'errorMessage' => 'The specified order charge does not support in RDS.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OrderId\\": 0,\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\\\t\\"\\n}","type":"json"}]', 'title' => 'RenewInstance', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" .'* MariaDB'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> Fees of an instance are changed if the call is successful. Before you call this operation, carefully read the following topics:'."\n" ."\n" .'* [Manually renew an ApsaraDB RDS for MySQL instance](~~96050~~)'."\n" .'* [Manually renew an ApsaraDB RDS for PostgreSQL instance](~~96741~~)'."\n" .'* [Manually renew an ApsaraDB RDS for SQL Server instance](~~95637~~)'."\n" .'* [Manually renew an ApsaraDB RDS for MariaDB instance](~~97122~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeDBInstancePromoteActivity' => [ 'summary' => 'The operation is phased out.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => true, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DbInstanceName', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5xxxxxxx', ], ], [ 'name' => 'AliUid', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the Alibaba Cloud account.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '22973492**********', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => '111', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AliUid' => [ 'description' => 'The ID of the Alibaba Cloud account.'."\n", 'type' => 'string', 'example' => '22973492**********', ], 'Bid' => [ 'description' => '* China site: 26842'."\n" .'* International site: 26888'."\n", 'type' => 'string', 'example' => '268**', ], 'DBInstanceId' => [ 'description' => 'The instance ID. You can call the [DescribeDBInstances](~~26232~~) operation to query the instance ID.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5xxxxxxx', ], 'DBInstanceName' => [ 'description' => 'The instance name.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5xxxxxxx', ], 'DBType' => [ 'description' => 'The type of the database engine. Valid values:'."\n" ."\n" .'* **MySQL**'."\n" .'* **PostgreSQL**'."\n" .'* **Oracle**'."\n", 'type' => 'string', 'example' => 'MySQL', ], 'IsActivity' => [ 'description' => 'The activity information about the instance. For more information, see [Instance activities](~~2391834~~).'."\n", 'type' => 'string', 'example' => '1', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '94CB8D93-017A-5AE7-A118-6E0F89D93C0A', ], ], 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'staticInfo' => [ 'noSubstitutionReason' => '暂无替代API，请关注后续API最新发布。', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"AliUid\\": \\"22973492**********\\",\\n \\"Bid\\": \\"26888\\",\\n \\"DBInstanceId\\": \\"rm-uf6wjk5******\\",\\n \\"DBInstanceName\\": \\"rm-uf6wjk5******\\",\\n \\"DBType\\": \\"MySQL\\",\\n \\"IsActivity\\": \\"1（表示目标实例未参加任何促销活动）\\",\\n \\"RequestId\\": \\"94CB8D93-017A-5AE7-A118-6E0F89D93C0A\\"\\n}","errorExample":""},{"type":"xml","example":"\\n E7573C51-7755-522A-B25B-8F7B221FAAE0\\n 1\\n 0\\n","errorExample":""}]', 'title' => 'DescribeDBInstancePromoteActivity', ], 'CreateDBInstance' => [ 'summary' => 'Creates an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the [DescribeRegions](~~610399~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'Engine', 'in' => 'query', 'schema' => [ 'description' => 'The database engine of the instance. Valid values:'."\n" ."\n" .'* **MySQL**'."\n" .'* **SQLServer**'."\n" .'* **PostgreSQL**'."\n" .'* **MariaDB**'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MySQL', ], ], [ 'name' => 'EngineVersion', 'in' => 'query', 'schema' => [ 'description' => 'The database engine version of the instance.'."\n" ."\n" .'* Regular RDS instance'."\n" ."\n" .' * Valid values when you set Engine to MySQL: **5.5**, **5.6**, **5.7**, and **8.0**'."\n" .' * Valid values when you set Engine to SQLServer: **08r2\\_ent_ha**(cloud disks, discontinued), **2008r2**(premium local disks, discontinued), **2012**(SQL Server EE Basic), **2012\\_ent_ha**, **2012\\_std_ha**, **2012\\_web**, **2014\\_ent_ha**, **2014\\_std_ha**, **2016\\_ent_ha**, **2016\\_std_ha**, **2016\\_web**, **2017\\_ent**, **2017\\_std_ha**, **2017\\_web**, **2019\\_ent**, **2019\\_std_ha**, **2019\\_web**, **2022\\_ent**, **2022\\_std_ha**, and **2022\\_web**'."\n" .' * Valid values when you set Engine to PostgreSQL: **10.0**, **11.0**, **12.0**, **13.0**, **14.0**, **15.0**, **16.0**, and **17.0**'."\n" .' * Valid values when you set Engine to MariaDB: **10.3** and **10.6**'."\n" ."\n" .'* Serverless RDS instance'."\n" ."\n" .' * Valid values when you set Engine to MySQL: **5.7** and **8.0**'."\n" .' * Valid values when you set Engine to SQLServer: **2016\\_std_sl**, **2017\\_std_sl**, and **2019\\_std_sl**'."\n" .' * Valid values when you set Engine to PostgreSQL: **14.0**, **15.0**, **16.0**, and **17.0**'."\n" ."\n" .'> '."\n" ."\n" .'* ApsaraDB RDS for MariaDB does not support serverless instances.'."\n" ."\n" .'* RDS instances that run SQL Server: `_ent` specifies SQL Server EE (Always On), `_ent_ha` specifies SQL Server EE, `_std_ha` specifies SQL Server SE, and `_web` specifies SQL Server Web.'."\n" ."\n" .'* RDS instances that run SQL Server 2014 are not available for purchase on the international site (alibabacloud.com).'."\n" ."\n" .'* Babelfish is supported only for RDS instances that run PostgreSQL 15.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '5.6', ], ], [ 'name' => 'DBInstanceClass', 'in' => 'query', 'schema' => [ 'description' => 'The instance type of the instance. You can specify an instance type of the standard or YiTian product type. For more information, see [Primary ApsaraDB RDS instance types](~~26312~~).'."\n" ."\n" .'To create a serverless instance, set this parameter to one of the following values:'."\n" ."\n" .'* If you want to create a serverless instance that runs MySQL on RDS Basic Edition, set this parameter to **mysql.n2.serverless.1c**.'."\n" .'* If you want to create a serverless instance that runs MySQL on RDS High-availability Edition, set this parameter to **mysql.n2.serverless.2c**.'."\n" .'* If you want to create a serverless instance that runs SQL Server, set this parameter to **mssql.mem2.serverless.s2**.'."\n" .'* If you want to create a serverless instance that runs PostgreSQL on RDS Basic Edition, set this parameter to **pg.n2.serverless.1c**.'."\n" .'* If you want to create a serverless instance that runs PostgreSQL on RDS High-availability Edition, set this parameter to **pg.n2.serverless.2c**.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rds.mysql.s1.small', ], ], [ 'name' => 'DBInstanceStorage', 'in' => 'query', 'schema' => [ 'description' => 'The storage capacity of the instance. Unit: GB. The storage capacity increases in increments of 5 GB. For more information, see [Primary ApsaraDB RDS instance types](~~26312~~).'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '100', ], ], [ 'name' => 'SystemDBCharset', 'in' => 'query', 'schema' => [ 'description' => 'A deprecated parameter. You do not need to specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'gbk', ], ], [ 'name' => 'DBInstanceNetType', 'in' => 'query', 'schema' => [ 'description' => 'The network connection type of the instance. The value of this parameter is fixed as **Intranet**, indicating an internal network connection.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'enumValueTitles' => [], 'example' => 'Internet', ], ], [ 'name' => 'DBInstanceDescription', 'in' => 'query', 'schema' => [ 'description' => 'The instance name. The value must be 2 to 255 characters in length The name can contain letters, digits, and hyphens (-) and must start with a letter.'."\n" ."\n" .'> The value cannot start with http:// or https://.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Test database'."\n", ], ], [ 'name' => 'SecurityIPList', 'in' => 'query', 'schema' => [ 'description' => 'The IP address whitelist of the instance. For more information, see [Configure an IP address whitelist](~~43185~~). Separate multiple IP addresses or CIDR blocks with commas (,). You can add up to 1,000 IP addresses or CIDR blocks to the whitelist. The entries in the IP address whitelist must be in one of the following formats:'."\n" ."\n" .'* IP addresses, such as 10.10.XX.XX.'."\n" .'* CIDR blocks, such as 10.10.XX.XX/24. In this example, 24 indicates that the prefix of each IP address in the IP address whitelist is 24 bits in length. You can replace 24 with a value within the range of 1 to 32.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '10.10.XX.XX/24', ], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCz*****', ], ], [ 'name' => 'PayType', 'in' => 'query', 'schema' => [ 'description' => 'The billing method of the instance. Valid values:'."\n" ."\n" .'* **Postpaid**: pay-as-you-go.'."\n" .'* **Prepaid**: subscription.'."\n" .'* **Serverless**: serverless. This value is not supported for instances that run MariaDB. For more information, see [Overview of serverless ApsaraDB RDS for MySQL instances](~~411291~~), [Overview of serverless ApsaraDB RDS for SQL Server instances](~~604344~~), and [Overview of serverless ApsaraDB RDS for PostgreSQL instances](~~607742~~).'."\n" ."\n" .'> The system automatically generates a purchase order and completes the payment.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Postpaid', ], ], [ 'name' => 'ZoneId', 'in' => 'query', 'schema' => [ 'description' => 'The zone ID of the primary instance.'."\n" ."\n" .'* If you specify a virtual private cloud (VPC) and a vSwitch, you must specify the ID of the zone to which the specified vSwitch belongs. Otherwise, the instance cannot be created.'."\n" .'* If the instance runs RDS High-availability Edition, you must specify the **ZoneIdSlave1** parameter. The ZoneIdSlave1 parameter specifies whether to use the single-zone deployment method or the multi-zone deployment method.'."\n" .'* If the instance runs RDS Enterprise Edition, you must specify the **ZoneIdSlave1** and **ZoneIdSlave2** parameters. The ZoneIdSlave1 and ZoneIdSlave2 parameters specify whether to use the single-zone deployment method or the multi-zone deployment method.'."\n" .'* If the instance runs MySQL on RDS Cluster Edition, you must specify the **ZoneIdSlave1** parameter for the RDS cluster that has two nodes and the **ZoneIdSlave1** and **ZoneIdSlave2** parameters for the RDS cluster that has three nodes.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-b', ], ], [ 'name' => 'ZoneIdSlave1', 'in' => 'query', 'schema' => [ 'description' => 'The zone ID of the secondary instance.'."\n" ."\n" .'* If you set this parameter to **Auto**, the multi-zone deployment method is used and the zone of the secondary instance is automatically configured.'."\n" .'* If you set this parameter to the same value as the **ZoneId** parameter, the single-zone deployment method is used.'."\n" .'* If you set this parameter to a value that is different from the value of the **ZoneId** parameter, the multiple-zone deployment method is used.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-c', ], ], [ 'name' => 'ZoneIdSlave2', 'in' => 'query', 'schema' => [ 'description' => 'The zone ID of the other secondary node. When you create an ApsaraDB RDS for MySQL cluster, you can create one to two secondary nodes for the cluster. This parameter applies if you create a cluster that contains two secondary nodes.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-d', ], ], [ 'name' => 'InstanceNetworkType', 'in' => 'query', 'schema' => [ 'description' => 'The network type of the instance. Valid values:'."\n" ."\n" .'* **VPC**: virtual private cloud (VPC)'."\n" .'* **Classic**: classic network'."\n" ."\n" .'> '."\n" ."\n" .'* If the instance runs MySQL and uses cloud disks, you must set this parameter to **VPC**.'."\n" ."\n" .'* If the instance runs PostgreSQL or MariaDB, you must set this parameter to **VPC**.'."\n" ."\n" .'* If the instance runs SQL Server Basic or SQL Server Web, you can set this parameter to VPC or Classic. If the instance runs other database engines, you must set this parameter to **VPC**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Classic', 'default' => 'VPC', ], ], [ 'name' => 'ConnectionMode', 'in' => 'query', 'schema' => [ 'description' => 'The connection mode of the instance. Valid values:'."\n" ."\n" .'* **Standard**: standard mode'."\n" .'* **Safe**: database proxy mode'."\n" ."\n" .'ApsaraDB RDS automatically assigns a connection mode to the instance.'."\n" ."\n" .'> SQL Server 2012, SQL Server 2016, and SQL Server 2017 support only the standard mode.', 'type' => 'string', 'required' => false, 'example' => 'Standard', ], ], [ 'name' => 'VPCId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the VPC to which the instance belongs.'."\n" ."\n" .'> This parameter is available when you set the **InstanceNetworkType** parameter to **VPC**.', 'type' => 'string', 'required' => false, 'example' => 'vpc-*****', ], ], [ 'name' => 'VSwitchId', 'in' => 'query', 'schema' => [ 'description' => 'The vSwitch ID.'."\n" ."\n" .'* **Relations with zones**: Specify the vSwitch ID based on the zones in which the vSwitch belongs to. If you specify two vSwitch IDs, make sure that the vSwitch IDs match the zone IDs specified by the ZoneId and ZoneIdSlave1 parameters.'."\n" .'* **Limits on the network type**: Set **InstanceNetworkType** to **VPC**.'."\n" .'* **Limits on multiple vSwitch IDs**: If you set **ZoneSlaveId1** to a value that is not **Auto**, you must specify the IDs of two vSwitches for this parameter and separate the IDs with a comma (,).'."\n" .'* **Limits on characters**: The value cannot contain `spaces` or the following characters: `!` `#` `￥` `&` `%`'."\n", 'type' => 'string', 'required' => false, 'example' => 'vsw-*****', ], ], [ 'name' => 'PrivateIpAddress', 'in' => 'query', 'schema' => [ 'description' => 'The private IP address of the instance. The private IP address must be within the CIDR block that is supported by the specified vSwitch. ApsaraDB RDS automatically assigns a private IP address to the instance based on the values of the **VPCId** and **vSwitchId** parameters.'."\n", 'type' => 'string', 'required' => false, 'example' => '172.16.XX.XX', ], ], [ 'name' => 'UsedTime', 'in' => 'query', 'schema' => [ 'description' => 'The subscription duration of the instance. Valid values:'."\n" ."\n" .'* If you set the **Period** parameter to **Year**, the value of the **UsedTime** parameter ranges from **1 to 5**.'."\n" .'* If you set the **Period** parameter to **Month**, the value of the **UsedTime** parameter ranges from **1 to 11**.'."\n" ."\n" .'> If you set the PayType parameter to **Prepaid**, you must also specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => '2', 'pattern' => '^\\d+$', 'enum' => [], ], ], [ 'name' => 'Period', 'in' => 'query', 'schema' => [ 'description' => 'The unit of the subscription duration. Valid values:'."\n" ."\n" .'* **Year**'."\n" .'* **Month**'."\n" ."\n" .'> If you set the PayType parameter to **Prepaid**, you must specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'enumValueTitles' => [], 'example' => 'Year', 'enum' => [ 'Year', 'Month', 'Day', '1', '2', '3', ], ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy*****', ], ], [ 'name' => 'DBInstanceStorageType', 'in' => 'query', 'schema' => [ 'description' => 'The storage type of the instance. Valid values:'."\n" ."\n" .'* **local_ssd**: Premium Local SSD (recommended)'."\n" .'* **general_essd**: Premium Enterprise SSD (ESSD) (recommend)'."\n" .'* **cloud_essd**: PL1 ESSD'."\n" .'* **cloud_essd2**: PL2 ESSD'."\n" .'* **cloud_essd3**: PL3 ESSD'."\n" .'* **cloud_ssd**: standard SSD. This storage type is not recommended. Standard SSDs are no longer available for purchase in some Alibaba Cloud regions.'."\n" ."\n" .'The default value of this parameter is determined by the instance type specified by the **DBInstanceClass** parameter.'."\n" ."\n" .'* If the instance type specifies the Premium Local SSD storage type, the default value of this parameter is **local_ssd**.'."\n" .'* If the instance type specifies the cloud disk storage type, the default value of this parameter is **cloud_essd**.'."\n" ."\n" .'> Serverless instances support only PL1 ESSDs and Premium ESSDs.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cloud_essd', ], ], [ 'name' => 'BusinessInfo', 'in' => 'query', 'schema' => [ 'description' => 'The additional business information about the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => '121436975448952', ], ], [ 'name' => 'EncryptionKey', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the key that is used for cloud disk encryption in the region in which the instance is deployed. If this parameter is specified, cloud disk encryption is enabled and you must also specify the **RoleARN** parameter. Cloud disk encryption cannot be disabled after it is enabled.'."\n" ."\n" .'You can obtain the ID of the key in the Key Management Service (KMS) console or create a key. For more information, see [Create a key](~~181610~~).'."\n" ."\n" .'> * This parameter is not required when you create an instance that runs MySQL, PostgreSQL, or SQL Server. You need to only specify the **RoleARN** parameter to create an instance that has cloud disk encryption enabled by using the obtained key ID.'."\n" .'> * You can configure RAM authorization to require a RAM user to enable cloud disk encryption when the RAM user is used to create an instance. If cloud disk encryption is disabled during the instance creation, the creation operation fails. To complete the configuration, you can attach the following policy to the RAM user: `{"Version":"1","Statement":[{"Effect":"Deny","Action":"rds:CreateDBInstance","Resource":"*","Condition":{"StringEquals":{"rds:DiskEncryptionRequired":"false"}}}]}`'."\n" ."\n\n" .'>The configuration also affects the CreateOrder operation that is called to create instances in the console.>', 'type' => 'string', 'required' => false, 'example' => '0d24*****-da7b-4786-b981-9a164dxxxxxx', ], ], [ 'name' => 'RoleARN', 'in' => 'query', 'schema' => [ 'description' => 'The Alibaba Cloud Resource Name (ARN) that is provided by your Alibaba Cloud account for Resource Access Management (RAM) users. RAM users can use the ARN to connect to ApsaraDB RDS to Key Management Service (KMS). You can call the CheckCloudResourceAuthorized operation to query the ARN.'."\n" ."\n" .'> When you enable the encryption, you must specify the RoleARN.'."\n", 'type' => 'string', 'required' => false, 'example' => 'acs:ram::1406xxxxxx:role/aliyunrdsinstanceencryptiondefaultrole', ], ], [ 'name' => 'AutoRenew', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable auto-renewal for the instance. You must specify this parameter only if the instance uses the subscription billing method. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n" ."\n" .'> * The auto-renewal cycle is one month for a monthly subscription.'."\n" .'> * The auto-renewal cycle is one year for a yearly subscription.', 'type' => 'string', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'Category', 'in' => 'query', 'schema' => [ 'description' => 'The RDS edition of the instance. Valid values:'."\n" ."\n" .'* Regular RDS instance'."\n" ."\n" .' * **Basic**: RDS Basic Edition'."\n" .' * **HighAvailability**: RDS High-availability Edition'."\n" .' * **cluster**: RDS Cluster Edition for ApsaraDB RDS for MySQL or PostgreSQL'."\n" .' * **AlwaysOn**: RDS Cluster Edition for ApsaraDB RDS for SQL Server'."\n" .' * **Finance**: RDS Basic Edition for serverless instances'."\n" ."\n" .'* Serverless RDS instance'."\n" ."\n" .' * **serverless_basic**: RDS Basic Edition for serverless instances. This edition is available only for instances that run MySQL and PostgreSQL.'."\n" .' * **serverless_standard**: RDS High-availability Edition for serverless instances. This edition is available only for instances that run MySQL and PostgreSQL.'."\n" .' * **serverless_ha**: RDS High-availability Edition for serverless instances. This edition is available only for instances that run SQL Server.'."\n" ."\n" .'> This parameter is required if PayType is set to Serverless.', 'type' => 'string', 'required' => false, 'example' => 'HighAvailability', ], ], [ 'name' => 'DedicatedHostGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the dedicated cluster to which the instance belongs.'."\n" ."\n" .'If you create the instance in a dedicated cluster, you must specify this parameter.'."\n" ."\n" .'* You can call the DescribeDedicatedHostGroups operation to query the information about the dedicated cluster.'."\n" .'* If no dedicated clusters are created, you can call the CreateDedicatedHostGroup operation to create a dedicated cluster.'."\n", 'type' => 'string', 'required' => false, 'example' => 'dhg-4n*****', ], ], [ 'name' => 'TargetDedicatedHostIdForMaster', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the host to which the instance belongs in the specified dedicated cluster.'."\n" ."\n" .'If you create the instance in a dedicated cluster, you must specify this parameter. If you do not specify this parameter, the system automatically assigns a host.'."\n" ."\n" .'* You can call the DescribeDedicatedHosts operation to query the host in the dedicated cluster.'."\n" .'* If no hosts are created, you can call the CreateDedicatedHost operation to create a host.'."\n", 'type' => 'string', 'required' => false, 'example' => 'i-bp*****1', ], ], [ 'name' => 'TargetDedicatedHostIdForSlave', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the host to which the secondary instance belongs in the specified dedicated cluster.'."\n" ."\n" .'If you want to create an instance that runs RDS High-availability Edition or RDS Enterprise Edition in a dedicated cluster, you must specify this parameter. If you do not specify this parameter, the system automatically assigns a host.'."\n" ."\n" .'* You can call the DescribeDedicatedHosts operation to query the host in the dedicated cluster.'."\n" .'* If no hosts are created, you can call the CreateDedicatedHost operation to create a host.'."\n", 'type' => 'string', 'required' => false, 'example' => 'i-bp*****2', ], ], [ 'name' => 'TargetDedicatedHostIdForLog', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the host to which the logger instance belongs in the specified dedicated cluster.'."\n" ."\n" .'If you want to create an instance that runs RDS Enterprise Edition in a dedicated cluster, you must specify this parameter. If you do not specify this parameter, the system automatically assigns a host.'."\n" ."\n" .'* You can call the DescribeDedicatedHosts operation to query the host in the dedicated cluster.'."\n" .'* If no hosts are created, you can call the CreateDedicatedHost operation to create a host.'."\n", 'type' => 'string', 'required' => false, 'example' => 'i-bp*****3', ], ], [ 'name' => 'DBParamGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The parameter template ID. You can call the DescribeParameterGroups operation to query the parameter template ID.'."\n" ."\n" .'> This parameter is available if you want to create an instance that runs MySQL or PostgreSQL. If you do not configure this parameter, the default parameter template is used. If you want to use a custom parameter template, you can customize a parameter template and set this parameter to the ID of the custom template.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rpg-sys-*****', ], ], [ 'name' => 'DBTimeZone', 'in' => 'query', 'schema' => [ 'description' => 'The time zone of the instance. This parameter takes effect only when you set **Engine** to **MySQL** or **PostgreSQL**.'."\n" ."\n" .'* **Engine** is set to **MySQL**:'."\n" ."\n" .' * This time zone is in UTC. Valid values: \\*\\*-12:59\\*\\* to **+13:00**.'."\n" .' * If the instance uses Premium Local SSDs, you can specify the name of the time zone. For example, you can specify the Asia/Hong_Kong time zone. For more information, see [Time zones](~~297356~~).'."\n" ."\n" .'* **Engine** is set to **PostgreSQL**.'."\n" ."\n" .' * This time zone is not in UTC. For more information, see [Time zones](~~297356~~).'."\n" .' * You can configure this parameter only when the RDS instance uses cloud disks.'."\n" ."\n" .'> * You can specify the time zone when you create a primary instance. You cannot specify the time zone when you create a read-only instance. Read-only instances inherit the time zone of their primary instance.'."\n" .'> * If you do not specify this parameter, the system automatically assigns the default time zone of the region in which the instance resides.', 'type' => 'string', 'required' => false, 'example' => '+08:00', ], ], [ 'name' => 'DBIsIgnoreCase', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether the table name is case-sensitive. Valid values:'."\n" ."\n" .'* **true**: Table names are not case-sensitive. This is the default value.'."\n" .'* **false**: Table names are case-sensitive.'."\n", 'type' => 'string', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'TargetMinorVersion', 'in' => 'query', 'schema' => [ 'description' => 'The minor engine version of the instance. This parameter is required only when you create an instance that runs MySQL or PostgreSQL. The value format varies based on the database engine of the instance.'."\n" ."\n" .'* If you create an instance that runs MySQL, the value is in the following format: `_`. Examples: `rds_20200229`, `xcluster_20200229`, and `xcluster80_20200229`.'."\n" ."\n" .' * rds: The instance runs RDS Basic Edition or RDS High-availability Edition.'."\n" .' * xcluster: The instance runs MySQL 5.7 on RDS Enterprise Edition.'."\n" .' * xcluster80: The instance runs MySQL 8.0 on RDS Enterprise Edition.'."\n" ."\n" .' > You can call the DescribeDBMiniEngineVersions operation to query the minor engine version. For more information about the differences between minor engine versions of AliSQL, see [Release notes](~~96060~~).'."\n" ."\n" .'* If you create an instance that runs PostgreSQL, the value is in the following format: `rds_postgres_00_`. Example: `rds_postgres_1400_20220830`.'."\n" ."\n" .' * 1400: The major engine version is PostgreSQL 14.'."\n" .' * 20220830: the AliPG version. You can call the DescribeDBMiniEngineVersions operation to query the AliPG version. For more information about minor engine versions, see [Release notes for AliPG](~~126002~~).'."\n" ."\n" .' > If you configure the **BabelfishConfig** parameter for your instance that runs PostgreSQL and set the babelfishEnabled field to true, the value of this parameter is in the following format: `rds_postgres_Major engine version00_AliPG version_babelfish`.', 'type' => 'string', 'required' => false, 'example' => 'rds_20200229', ], ], [ 'name' => 'StorageAutoScale', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable the automatic storage expansion feature for the instance. This feature is supported if the instance runs MySQL or PostgreSQL. Valid values:'."\n" ."\n" .'* **Enable**: enables the feature.'."\n" .'* **Disable** (default): disables the feature.'."\n" ."\n" .'> After the instance is created, you can call the ModifyDasInstanceConfig operation to adjust the settings. For more information, see [Configure automatic storage expansion](~~173826~~).'."\n", 'type' => 'string', 'required' => false, 'enumValueTitles' => [], 'example' => 'Disable', 'enum' => [ 'Enable', 'Disable', ], ], ], [ 'name' => 'StorageThreshold', 'in' => 'query', 'schema' => [ 'description' => 'The threshold in percentage based on which automatic storage expansion is triggered.'."\n" ."\n" .'* **10**'."\n" .'* **20**'."\n" .'* **30**'."\n" .'* **40**'."\n" .'* **50**'."\n" ."\n" .'> If you set the **StorageAutoScale** parameter to **Enable**, you must specify this parameter.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'enumValueTitles' => [], 'example' => '50', 'enum' => [ '10', '20', '30', '40', '50', ], ], ], [ 'name' => 'StorageUpperBound', 'in' => 'query', 'schema' => [ 'description' => 'The maximum storage capacity that is allowed for automatic storage expansion. The storage capacity of the instance cannot exceed the maximum storage capacity. Unit: GB.'."\n" ."\n" .'> * Valid values: an integer greater than or equal to 0.'."\n" .'> * If you set **StorageAutoScale** to **Enable**, you must specify this parameter.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '0', 'example' => '2000', ], ], [ 'name' => 'DryRun', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to perform a dry run. Default value: false. Valid values:'."\n" ."\n" .'* **true**: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, service limits, and insufficient inventory errors.'."\n" .'* **false** (default): performs a dry run and sends the request. If the request passes the dry run, the instance is created.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false', ], ], [ 'name' => 'UserBackupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the full backup file. You can call the ListUserBackupFiles operation to query the ID of the full backup file. If you want to create an instance by using the data of a backup file, you must specify this parameter.'."\n" ."\n" .'This parameter is supported only when the following requirements are met:'."\n" ."\n" .'* The **PayType** parameter is set to **Postpaid**.'."\n" .'* The **Engine** parameter is set to **MySQL**.'."\n" .'* The **EngineVersion** parameter is set to **5.7**.'."\n" .'* The **Category** parameter is set to **Basic**.'."\n", 'type' => 'string', 'required' => false, 'example' => '67798*****', ], ], [ 'name' => 'Amount', 'in' => 'query', 'schema' => [ 'description' => 'The number of ApsaraDB RDS for MySQL instances that you want to create. The parameter takes effect only when you create multiple ApsaraDB RDS for MySQL instances at a time by using a single request.'."\n" ."\n" .'Valid values: **1** to **20**. Default value: **1**.'."\n" ."\n" .'> * If you want to create multiple ApsaraDB RDS for MySQL instances at a time by using a single request, you can add tags to all the instances by using the **Tag.Key** parameter and the **Tag.Value** parameter. After the instances are created, you can manage the instances based on the tags.'."\n" .'> * After you submit a request to create multiple ApsaraDB RDS for MySQL instances, this operation returns **TaskId**, **RequestId**, and **Message**. You can call the DescribeDBInstanceAttribute operation to query the information about an instance.'."\n" .'> * If the value of the **Engine** parameter is not **MySQL** and the value of the Amount parameter is greater than **1**, this operation fails and returns an error code `InvalidParam.Engine`.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', ], ], [ 'name' => 'CreateStrategy', 'in' => 'query', 'schema' => [ 'description' => 'The policy based on which multiple instances are created. The parameter takes effect only when the value of the **Amount** parameter is greater than 1. Valid values:'."\n" ."\n" .'* **Atomicity** (default): atomicity. The instances are all created together. If one instance cannot be created, none of the instances are created.'."\n" .'* **Partial**: non-atomicity. Each instance is independently created. The failure in creating an instance does not affect the creation of the other instances.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Atomicity', ], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The tags that are added to instances.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details of the tag.'."\n", 'type' => 'object', 'properties' => [ 'Key' => [ 'description' => 'The tag key. You can use this parameter to add tags to the instance.'."\n" ."\n" .'* If the specified tag key is an existing key, the system directly adds the tag key to the instance. You can call the ListTagResources to query the existing tag.'."\n" .'* If the specified tag key does not exist, the system creates the tag key and adds the tag key to the instance.'."\n" .'* The value cannot be an empty string.'."\n" .'* This parameter must be used together with the **Tag.Value** parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testkey1', ], 'Value' => [ 'description' => 'The tag value. You can use this parameter to add tags to the instance.'."\n" ."\n" .'* If the specified tag value is found in the specified tag key, the system directly adds the tag value to the instance. You can call the ListTagResources to query the existing tag.'."\n" .'* If the specified tag value is not found in the specified tag key, the system creates the tag value and adds the tag value to the instance.'."\n" .'* This parameter must be used together with the **Tag.Key** parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testvalue1', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 21, ], ], [ 'name' => 'DeletionProtection', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable the release protection feature for the instance. This feature is available only for pay-as-you-go instances. Valid values:'."\n" ."\n" .'* **true**: enables the feature.'."\n" .'* **false** (default): disables the feature.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false', ], ], [ 'name' => 'BabelfishConfig', 'in' => 'query', 'schema' => [ 'description' => 'The configuration of the Babelfish feature for the instance that runs PostgreSQL.'."\n" ."\n" .'Format:{"babelfishEnabled":"true","migrationMode":"xxxxxxx","masterUsername":"xxxxxxx","masterUserPassword":"xxxxxxxx"}'."\n" ."\n" .'The following list describes the fields in the format:'."\n" ."\n" .'* **babelfishEnabled**: specifies whether to enable Babelfish for the instance. If you set this field to **true**, you enable Babelfish for the instance. If you leave this parameter empty, Babelfish is disabled for the instance.'."\n" .'* **migrationMode**: The migration mode of the instance. Valid values: **single-db** and **multi-db**.'."\n" .'* **masterUsername**: The username of the administrator account. The username can contain lowercase letters, digits, and underscores (\\_). It must start with a letter and end with a letter or digit. It can be up to 63 characters in length and cannot start with pg.'."\n" .'* **masterUserPassword**: The password of the administrator account. The password must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. It must be 8 to 32 characters in length. The password can contain any of the following characters: `! @ # $ % ^ & * ( ) _ + - =`.'."\n" ."\n" .'> This parameter applies only to ApsaraDB RDS for PostgreSQL instances. For more information about Babelfish for ApsaraDB RDS for PostgreSQL, see [Introduction to Babelfish](~~428613~~).', 'type' => 'string', 'required' => false, 'example' => '{"babelfishEnabled":"true","migrationMode":"single-db","masterUsername":"babelfish_user","masterUserPassword":"Babelfish123!"}', ], ], [ 'name' => 'ServerlessConfig', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The settings of the serverless instance. These parameters are required only when you create a serverless instance.'."\n" ."\n" .'> ApsaraDB RDS for MariaDB does not support serverless instances.'."\n", 'type' => 'object', 'properties' => [ 'MaxCapacity' => [ 'description' => 'The maximum number of RDS Capacity Units (RCUs). Valid values:'."\n" ."\n" .'* Serverless ApsaraDB RDS for MySQL instances: **1 to 32**'."\n" .'* Serverless ApsaraDB RDS for SQL Server instances: **2 to 16**'."\n" .'* Serverless ApsaraDB RDS for PostgreSQL instances: **1 to 14**'."\n" ."\n" .'> The value of this parameter must be greater than or equal to the value of the **MinCapacity** parameter and can be set only to an **integer**.'."\n", 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '8', 'default' => '8.0', ], 'MinCapacity' => [ 'description' => 'The minimum number of RCUs. Valid values:'."\n" ."\n" .'* Serverless ApsaraDB RDS for MySQL instances: **0.5 to 32**.'."\n" .'* Serverless ApsaraDB RDS for SQL Server instances: **2 to 16**. Only integers are supported.'."\n" .'* Serverless ApsaraDB RDS for PostgreSQL instances: **0.5 to 14**'."\n" ."\n" .'> The value of this parameter must be less than or equal to the value of the **MaxCapacity** parameter.'."\n", 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '0.5', 'default' => '0.5', ], 'AutoPause' => [ 'description' => 'Specifies whether to enable the automatic startup and stop feature for the serverless instance. Valid values:'."\n" ."\n" .'* **true**: enables the feature.'."\n" .'* **false** (default): disables the feature.'."\n" ."\n" .'> This parameter is required only for serverless instances that run MySQL and PostgreSQL. After the automatic start and stop feature is enabled, if no connections to the instance are established within 10 minutes, the instance is suspended. After a connection to the instance is established, the instance is resumed.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false', ], 'SwitchForce' => [ 'description' => 'Specifies whether to enable the forced scaling feature for the serverless instance. Valid values:'."\n" ."\n" .'* **true**: enables the feature.'."\n" .'* **false** (default): disables the feature.'."\n" ."\n" .'> '."\n" ."\n" .'* This parameter is required only for serverless instances that run MySQL and PostgreSQL. If you set this parameter to true, a service interruption that lasts approximately 30 to 120 seconds occurs during forced scaling. Process with caution.'."\n" ."\n" .'* The RCU scaling for a serverless instance immediately takes effect. In some cases, such as the execution of large transactions, the scaling does not immediately take effect. In this case, you can enable this feature to forcefully scale the RCUs of the instance.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false', ], ], 'required' => false, ], ], [ 'name' => 'ConnectionString', 'in' => 'query', 'schema' => [ 'description' => 'The internal endpoint that is used to connect to the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rm-uf6wjk5*****.mysql.rds.aliyuncs.com', ], ], [ 'name' => 'Port', 'in' => 'query', 'schema' => [ 'description' => 'The port. You can initialize the port when you create the instance.'."\n" ."\n" .'* Valid values if the instance runs MySQL: 1000 to 65534'."\n" .'* Valid values if the instance runs PostgreSQL, SQL Server, or MariaDB: 1000 to 5999'."\n", 'type' => 'string', 'required' => false, 'example' => '3306', ], ], [ 'name' => 'BurstingEnabled', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable the I/O burst feature of Premium ESSDs. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n" ."\n" .'> For more information about the I/O burst feature of general ESSDs, see [What are Premium ESSDs?](~~2340501~~)'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'AutoPay', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable automatic payment. Valid values:'."\n" ."\n" .'* **true**: enables the feature. Make sure that your account balance is sufficient when you enable automatic payment.'."\n" .'* **false**: does not automatically complete the payment. An unpaid order is generated.'."\n" ."\n" .'> Default value: true. If your account balance is insufficient, you can set AutoPay to false to generate an unpaid order. Then, you can log on to the ApsaraDB RDS console to complete the payment.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true', ], ], [ 'name' => 'IoAccelerationEnabled', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable Buffer Pool Extension (BPE) of Premium ESSDs. Valid values:'."\n" ."\n" .'* **1**: enables BPE.'."\n" .'* **0**: disables BPE.'."\n" ."\n" .'> For more information about Buffer Pool Extension(BPE) of Premium ESSDs, see [Buffer Pool Extension(BPE)](~~2527067~~).'."\n", 'type' => 'string', 'required' => false, 'example' => '0', ], ], [ 'name' => 'ColdDataEnabled', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable the data archiving feature of Premium ESSDs. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n" ."\n" .'> For more information about the data archiving feature of Premium ESSDs, see [Use the data archiving feature](~~2701832~~).'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'WhitelistTemplateList', 'in' => 'query', 'schema' => [ 'description' => 'The entries in the whitelist. If you enter multiple IP addresses or CIDR blocks, you must separate the IP addresses or CIDR blocks with commas (,). Do not add spaces preceding or following the commas. Example: `192.168.0.1,172.16.213.9`.'."\n", 'type' => 'string', 'required' => false, 'example' => '192.XXX.XX.1,172.XXX.XX.9', ], ], [ 'name' => 'AutoCreateProxy', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to automatically create a proxy. Valid values:'."\n" ."\n" .'* **true**: automatically creates a database proxy. By default, a general-purpose database proxy is created.'."\n" .'* **false**: does not automatically create a database proxy.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false', ], ], [ 'name' => 'AutoUseCoupon', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to use a coupon. Default value: false. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n" ."\n" .'> If you downgrade the specifications of an instance after you use coupons, the used coupons cannot be refunded.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'PromotionCode', 'in' => 'query', 'schema' => [ 'description' => 'The coupon code.'."\n", 'type' => 'string', 'required' => false, 'example' => 'aliwood-1688-mobile-promotion', ], ], [ 'name' => 'OptimizedWrites', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable the 16K atomic write feature. Valid values:'."\n" ."\n" .'* **optimized**: enables the 16K atomic write feature.'."\n" .'* **none** (default): does not enable the 16K atomic write feature.'."\n" ."\n" .'> For more information, see [Use the 16K atomic write feature](~~2858761~~).'."\n", 'type' => 'string', 'required' => false, 'example' => 'optimized', 'enum' => [ 'optimized', 'none', ], ], ], [ 'name' => 'ExternalReplication', 'in' => 'query', 'schema' => [ 'type' => 'boolean', 'required' => false, 'default' => 'false', ], ], [ 'name' => 'CustomExtraInfo', 'in' => 'query', 'schema' => [ 'type' => 'string', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'DryRunResult' => [ 'description' => 'Indicates whether the request passed the dry run. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n" ."\n" .'> * If the system does not perform a dry run, this parameter is not returned.'."\n" .'> * If the request failed the dry run, an error message is returned.', 'type' => 'boolean', 'example' => 'true', ], 'TagResult' => [ 'description' => 'Indicates whether the specified tag is added to the instance. Valid values:'."\n" ."\n" .'* **true**: The specified tag is added to the instance.'."\n" .'* **false**: The specified tag fails to be added to the instance.'."\n" ."\n" .'> If you do not add a tag to the instance, this parameter is not returned.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC', ], 'ConnectionString' => [ 'description' => 'The internal endpoint of the instance.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5*****.mysql.rds.aliyuncs.com', ], 'Message' => [ 'description' => 'The message that indicates whether multiple instances are created.'."\n" ."\n" .'> The parameter is returned only when the value of the **Amount** parameter is greater than 1.'."\n", 'type' => 'string', 'example' => 'Batch Create DBInstance Task Is In Process.', ], 'DBInstanceId' => [ 'description' => 'The instance ID. If the value of the **Amount** parameter is greater than **1**, more than one instance ID is returned. The number of instance IDs that are returned is the same as the value of the Amount parameter. The returned instance IDs are separated by commas (,).'."\n" ."\n" .'For example, if the value of the **Amount** parameter is **3**, three instance IDs are returned. Examples: `rm-uf6wjk5*****1,rm-uf6wjk5*****2,rm-uf6wjk5*****3`'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5*****', ], 'Port' => [ 'description' => 'The internal IP address and port number that are used to connect to the instance.'."\n", 'type' => 'string', 'example' => '3306', ], 'TaskId' => [ 'description' => 'The ID of the task that is run to create multiple instances.'."\n" ."\n" .'* This parameter is returned only when the value of **Amount** is greater than 1.'."\n" .'* The **TaskID** parameter cannot be used to query a task.'."\n", 'type' => 'string', 'example' => 's2365879-a9d0-55af-fgae-f2*****', ], 'DryRun' => [ 'description' => 'Indicates that the system performed a dry run.'."\n" ."\n" .'* The value is fixed as **true**.'."\n" .'* If the system does not perform a dry run, this parameter is not returned.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'OrderId' => [ 'description' => 'The order ID.'."\n", 'type' => 'string', 'example' => '1007893702*****', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Invalid.ParamGroupDBVersion', 'errorMessage' => '%s.%s', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'RR309', 'errorMessage' => 'We have detected a security risk with your payment method. Please proceed with verification via the link in your email or console message and re-submit your order after verification.', ], [ 'errorCode' => 'InvalidZoneId.NotSupported', 'errorMessage' => 'The Specified vpc Zone not supported.', ], [ 'errorCode' => 'InvalidZone.NotSupportedForStorageType', 'errorMessage' => 'The specified zone is closed or invalid for Specified DBInstanceStorageType.', ], [ 'errorCode' => 'InvalidNetworkTypeClassicWhenCloudStorage', 'errorMessage' => 'The Specified InstanceNetworkType value Classic is not valid when choose cloud storage type.', ], [ 'errorCode' => 'InvalidZone.NotSupported', 'errorMessage' => 'The Specified Zone not supported.', ], [ 'errorCode' => 'InvalidEssdStorageSize', 'errorMessage' => 'invalid cloud essd storage size.', ], [ 'errorCode' => 'InvalidParameter', 'errorMessage' => 'Some Reuquest Parameters Is Invalid. Check or Try It Again Later.', ], [ 'errorCode' => 'Pay.AmountLimitExceeded', 'errorMessage' => 'Pay amount limit exceeded.', ], [ 'errorCode' => 'IncompleteAccountInfo', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'IncompleteTaxInfo', 'errorMessage' => 'Your tax information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'InvalidPaymentMethod.Incomplete', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'InvalidPaymentMethod.Missing', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'InsuffcientBalanceOrBankAccount', 'errorMessage' => 'Add a payment method or add funds to the prepayment balance. Get started by creating an instance.', ], [ 'errorCode' => 'InvalidPaymentMethod.NoAccess', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'InvalidPaymentMethod.InsufficientBalance', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method or add funds to the prepayment balance.', ], [ 'errorCode' => 'Pay.LowFunds', 'errorMessage' => 'The balance of the advance payment is insufficient or there is no balance of the advance payment.', ], [ 'errorCode' => 'Pay.ChargeChannelNotFound', 'errorMessage' => 'Failure to obtain the first external payment channel if the advance balance is insufficient.', ], [ 'errorCode' => 'VswitchIpExhausted', 'errorMessage' => 'Vswitch IP exhausted.', ], [ 'errorCode' => 'InvalidPrivateIpAddress.AlreadyUsed', 'errorMessage' => 'The specified IP is already used.', ], [ 'errorCode' => 'InvalidEcsImage.NotFound', 'errorMessage' => 'Sepcified ecs image does not exist', ], [ 'errorCode' => 'InvalidMinorVersion.NotFound', 'errorMessage' => 'Sepcified minor version does not exists.', ], [ 'errorCode' => 'InvalidConcurrentOperate', 'errorMessage' => 'Concurrent operation is detected.', ], [ 'errorCode' => 'ZoneId.NotMatchWithCategory', 'errorMessage' => 'The number of ZoneId specified does not match with category.', ], [ 'errorCode' => 'InvalidSecurityIPList.Format', 'errorMessage' => 'The specified parameter securityIPList is not valid.', ], [ 'errorCode' => 'InvalidDBParamGroupId.Format', 'errorMessage' => 'The specified parameter dbParamGroupId is not valid.', ], [ 'errorCode' => 'InvalidTargetMinorVersion.Format', 'errorMessage' => 'The specified parameter targetMinorVersion is not valid.', ], [ 'errorCode' => 'InvalidDedicatedHostGroupId.Format', 'errorMessage' => 'The specified parameter dedicatedHostGroupId is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceClass.Malformed', 'errorMessage' => 'The specified parameter DBInstanceClass is not valid.', ], [ 'errorCode' => 'InvalidEngineVersion.Malformed', 'errorMessage' => 'The specified parameter EngineVersion is not valid.', ], [ 'errorCode' => 'CreditPayInsufficientBalance', 'errorMessage' => 'Insufficient credit pay limit. Please contact your channel partner to increase the limit.', ], [ 'errorCode' => 'InvalidTagKey.Malformed', 'errorMessage' => 'The Tag.N.Key parameter is empty.', ], [ 'errorCode' => 'InvalidTagValue.Malformed', 'errorMessage' => 'The Tag.N.Value parameter is empty.', ], [ 'errorCode' => 'Duplicate.TagKey', 'errorMessage' => 'The Tag.N.Key contains duplicate keys.', ], [ 'errorCode' => 'NumberExceed.Tags', 'errorMessage' => 'The maximum number of Tags is exceeded. The maximum is 20.', ], [ 'errorCode' => 'MissingParameter.ResourceIds', 'errorMessage' => 'The parameter ResourceIds.N must not be null.', ], [ 'errorCode' => 'InvalidParameter.TagKey', 'errorMessage' => 'The Tag.N.Key parameter is invalid.', ], [ 'errorCode' => 'InvalidParameter.TagValue', 'errorMessage' => 'The Tag.N.Value parameter is invalid.', ], [ 'errorCode' => 'NoPermission.SystemTag', 'errorMessage' => 'You have no permission to use system tags.', ], [ 'errorCode' => 'InvalidParam.Amount', 'errorMessage' => 'Amount is allowed from 1 to 20.', ], [ 'errorCode' => 'InvalidParam.CreateStrategy', 'errorMessage' => 'Only Atomicity and Partial are allowed.', ], [ 'errorCode' => 'InvalidParam.Engine', 'errorMessage' => 'Only MySQL is allowed when Amount > 1.', ], [ 'errorCode' => 'InvalidMultiZoneInfoList', 'errorMessage' => 'The Specified Zone Info List is Invaild.', ], [ 'errorCode' => 'InvalidKmsConfigStatus', 'errorMessage' => 'The Kms Service Config is Invalid.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the Aliyun RDS.', ], [ 'errorCode' => 'InvalidPort.Malformed', 'errorMessage' => 'Specified port is not valid.', ], [ 'errorCode' => 'InvalidUsedTime', 'errorMessage' => 'UsedTime can not Less than or equal to zero.', ], [ 'errorCode' => 'Kms.Unauthorized', 'errorMessage' => 'KMS has not been authorized.', ], [ 'errorCode' => 'InvalidDBInstanceClass.Offline', 'errorMessage' => 'The specified instance type is no longer provided. Please specify another instance type.', ], [ 'errorCode' => 'SystemParamGroupCode.Format', 'errorMessage' => 'Specific DBParamGroupId is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceName.Duplicate', 'errorMessage' => 'Specified DB instance name already exists in the Aliyun RDS.', ], [ 'errorCode' => 'ServiceLinkedRole.NotExist', 'errorMessage' => 'Service linked role for RDS PostgreSQL not exist.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'Cloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024.', ], [ 'errorCode' => 'InvalidPrivateIpAddress.Format', 'errorMessage' => 'The specified private IP address format is incorrect.', ], [ 'errorCode' => 'InvalidPrivateIpAddress.Mismatch', 'errorMessage' => 'Specified private IP address is not in the CIDR block of virtual switch.', ], [ 'errorCode' => 'TooManyWhitelistTemplateIds', 'errorMessage' => 'create dbinstance can support attach to up to 10 whitelist templates.', ], [ 'errorCode' => 'UnsupportExtendDisk.NotSupport', 'errorMessage' => 'Specified DB instance is unsupport extend disk.', ], [ 'errorCode' => 'InvalidWhitelistTemplateId', 'errorMessage' => 'the template id list is invalid.', ], [ 'errorCode' => 'InvalidRequestId', 'errorMessage' => 'The request is copy, check your token.', ], [ 'errorCode' => 'InvalidParameter.MinCapacity', 'errorMessage' => 'The specified parameter \'MinCapacity\' is not valid.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidParameter.NotSupportDBInstanceStorageType', 'errorMessage' => 'Parameter DBInstanceStorageType is invalid.', ], [ 'errorCode' => 'InvalidParam.InstanceNetworkType', 'errorMessage' => 'Creation of classic network instances is not supported.', ], [ 'errorCode' => 'InvalidOrder.NotFound', 'errorMessage' => 'Specified order does not exist in RDS.', ], [ 'errorCode' => 'InvalidVSwitchId.Format', 'errorMessage' => 'The specified vswitch Id format is incorrect.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'IncorrectTargetCategory', 'errorMessage' => 'Current target category does not support this operation.', ], [ 'errorCode' => 'PurchaseDurationInsufficient', 'errorMessage' => 'The purchase duration does not meet the requirements, please choose again.', ], [ 'errorCode' => 'NotFound.ParamGroupId', 'errorMessage' => 'Current ParamGroupId not found.', ], [ 'errorCode' => 'InvalidParamForXfs', 'errorMessage' => 'Xfs instance must be single tenant standard instance.', ], [ 'errorCode' => 'UnsupportedColdData', 'errorMessage' => 'Current coldDataEnabled parameter can not support.', ], [ 'errorCode' => 'AtLeastThreeVSwitchAvailableIp', 'errorMessage' => 'The primary vswitch requires at least three available IP addresses.', ], [ 'errorCode' => 'AtLeastTwoVSwitchAvailableIp', 'errorMessage' => 'The primary vswitch requires at least two available IP addresses.', ], [ 'errorCode' => 'DuckDBOperationConflictBetweenPrimaryAndReadOnlyInstance', 'errorMessage' => 'Current instance is already attached to another duckdb instance, operation is conflict.', ], ], [ [ 'errorCode' => 'CannotDecreaseEssdPerfLevel', 'errorMessage' => 'cannot decrease cloud essd performance level.', ], ], 403 => [ [ 'errorCode' => 'ByokRoleArnNotFound', 'errorMessage' => 'The roleArn can not be null.', ], [ 'errorCode' => 'RISK.RISK_CONTROL_REJECTION', 'errorMessage' => 'Risk control rejection.', ], [ 'errorCode' => 'AliCroup2CloudUserCannotBuyNotInnerCommodity', 'errorMessage' => 'There is no group cloud commodity label, and users within the group are not allowed to purchase.', ], [ 'errorCode' => 'GroupReplicationNotSupport.InvalidEngineVersion', 'errorMessage' => 'Group Replication requires the instance engine version to be 8.0.', ], [ 'errorCode' => 'GroupReplicationNotSupport.InvalidNodeClassCode', 'errorMessage' => 'Group Replication requires the ClassCode of each node to be consistent.', ], [ 'errorCode' => 'GroupReplicationNotSupport.InvalidNodeNum', 'errorMessage' => 'Group Replication is not supported, the number of nodes must be an odd number greater than or equal to 3.', ], [ 'errorCode' => 'GroupReplicationNotSupport.InvalidXengine', 'errorMessage' => 'Group Replication is not supported because the instance has xengine tables.', ], [ 'errorCode' => 'GroupReplicationNotSupport.MemoryTooSmall', 'errorMessage' => 'Group Replication is not supported because the memory is too small.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'CloudDiskEncryptionNotSupport', 'errorMessage' => 'The encryption key is not allowed for general-purpose instance.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'BasicCategoryNotSupport', 'errorMessage' => 'The Basic category is not supported.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], [ 'errorCode' => 'IncorrectCharacterType', 'errorMessage' => 'Current DB instance character type does not support this operation.', ], ], [ [ 'errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The target availability zone does not have sufficient resources.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"DryRunResult\\": true,\\n \\"TagResult\\": true,\\n \\"RequestId\\": \\"1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC\\",\\n \\"ConnectionString\\": \\"rm-uf6wjk5****.mysql.rds.aliyuncs.com\\",\\n \\"Message\\": \\"Batch Create DBInstance Task Is In Process.\\",\\n \\"DBInstanceId\\": \\"rm-uf6wjk5****\\",\\n \\"Port\\": \\"3306\\",\\n \\"TaskId\\": \\"s2365879-a9d0-55af-fgae-f2****\\",\\n \\"DryRun\\": true,\\n \\"OrderId\\": \\"1007893702****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 1007893702*****\\n rm-uf6wjk5*****.mysql.rds.aliyuncs.com\\n rm-uf6wjk5*****\\n 3306\\n 1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC\\n","errorExample":""}]', 'title' => 'CreateDBInstance', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" .'* MariaDB'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> Fees of an instance are changed if the call is successful. Before you call this operation, carefully read the related topics. If an error message appears when you call this operation, you can search for the error message to view the cause of the error.'."\n" ."\n" .'* [Create an ApsaraDB RDS for MySQL instance](~~148036~~).'."\n" .'* [Create a serverless ApsaraDB RDS for MySQL instance](~~412231~~).'."\n" .'* [Create an ApsaraDB RDS for PostgreSQL instance](~~148038~~)'."\n" .'* [Create a serverless ApsaraDB RDS for PostgreSQL instance](~~607753~~)'."\n" .'* [Create an ApsaraDB RDS for PostgreSQL instance for which Babelfish is enabled](~~428615~~)'."\n" .'* [Create an ApsaraDB RDS for SQL Server instance](~~148037~~)'."\n" .'* [Create a serverless ApsaraDB RDS for SQL Server instance](~~603465~~)'."\n" .'* [Create an ApsaraDB RDS for MariaDB instance](~~148040~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => '> In the latest version of SDK, the default timeout period on the client side is different from the default timeout period on the instance. If you use the latest version of SDK to call this operation, a timeout error may be reported even if this operation is successfully called. To prevent this issue, you can set ReadTimeout to 20000 before you call this operation.'."\n" .'', 'extraInfo' => ' ', ], 'CreateDBInstanceForRebuild' => [ 'summary' => 'Rebuilds an instance from the recycle bin.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the [DescribeRegions](~~610399~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the [DescribeDBInstances](~~610396~~) operation to query the ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-uf6wjk5xxxxxxx', ], ], [ 'name' => 'PayType', 'in' => 'query', 'schema' => [ 'description' => 'The billing method of the destination instance. Valid values:'."\n" ."\n" .'* **Postpaid**: pay-as-you-go'."\n" .'* **Prepaid**: subscription'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Postpaid', ], ], [ 'name' => 'SecurityIPList', 'in' => 'query', 'schema' => [ 'description' => 'The IP address whitelist of the serverless instance. For more information, see [Use a database client or the CLI to connect to an ApsaraDB RDS for PostgreSQL instance](~~43185~~). If the IP address whitelist contains more than one entry, separate the entries with commas (,). Each entry must be unique. You can specify up to 1,000 entries. The entries in the IP address whitelist must be in one of the following formats:'."\n" ."\n" .'* IP addresses, such as 10.10.XX.XX.'."\n" .'* CIDR blocks, such as 10.10.XX.XX/24. In this example, 24 indicates that the prefix of each IP address in the IP address whitelist is 24 bits in length. You can replace 24 with a value within the range of 1 to 32.'."\n" ."\n" .'If this parameter is not specified, the default IP address whitelist is used.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '127.0.0.1', ], ], [ 'name' => 'DBInstanceDescription', 'in' => 'query', 'schema' => [ 'description' => 'The name of the instance. The name must be 2 to 256 characters in length. The name can contain letters, digits, underscores (\\_), and hyphens (-). The name must start with a letter.'."\n" ."\n" .'> : The name cannot start with http:// or https://.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Test database'."\n", ], ], [ 'name' => 'ZoneId', 'in' => 'query', 'schema' => [ 'description' => 'The zone ID of the primary instance. You can call the [DescribeRegions](~~26243~~) operation to query the most recent zone list.'."\n" ."\n" .'> If you specify a virtual private cloud (VPC) and a vSwitch, you must specify this parameter to identify the zone for the vSwitch.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-e', ], ], [ 'name' => 'ZoneIdSlave1', 'in' => 'query', 'schema' => [ 'description' => 'The zone ID of the secondary instance.'."\n" ."\n" .'> If the instance does not run RDS Basic Edition, you must specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-c', ], ], [ 'name' => 'ZoneIdSlave2', 'in' => 'query', 'schema' => [ 'description' => 'The zone ID of the logger instance.'."\n" ."\n" .'> This parameter is available only when the instance runs RDS Enterprise Edition.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-d', ], ], [ 'name' => 'VPCId', 'in' => 'query', 'schema' => [ 'description' => 'The VPC ID of the instance. If you set **InstanceNetworkType** to **VPC**, you must specify this parameter.'."\n" ."\n" .'> : If you specify this parameter, you must also specify **ZoneId**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vpc-uf6f7l4fg90xxxxxx', ], ], [ 'name' => 'VSwitchId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the vSwitch. The vSwitch must belong to the zone that is specified by **ZoneId**.'."\n" ."\n" .'> '."\n" ."\n" .'* If you set **InstanceNetworkType** to **VPC**, you must also specify this parameter.'."\n" ."\n" .'* If you specify the ZoneSlaveId1 parameter, you must specify the IDs of two vSwitches for this parameter and separate the IDs with a comma (,).'."\n", 'type' => 'string', 'required' => false, 'example' => 'vsw-uf6adz52c2pxxxxx', ], ], [ 'name' => 'Period', 'in' => 'query', 'schema' => [ 'description' => 'The unit of the subscription duration. Valid values:'."\n" ."\n" .'* **Year**'."\n" .'* **Month**'."\n" ."\n" .'> If you set the PayType parameter to **Prepaid**, you must also specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'enumValueTitles' => [], 'example' => 'Month', 'enum' => [ 'Year', 'Month', '1', '2', ], ], ], [ 'name' => 'UsedTime', 'in' => 'query', 'schema' => [ 'description' => 'The subscription duration of the instance. Valid values:'."\n" ."\n" .'* If you set **Period** to **Year**, the value of **UsedTime** ranges from **1** to **5**.'."\n" .'* If you set **Period** to **Month**, the value of **UsedTime** ranges from **1** to **11**.'."\n" ."\n" .'> If you set **PayType** to **Prepaid**, you must specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => '1', ], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests.'."\n" ."\n" .'The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxx', ], ], [ 'name' => 'DBInstanceNetType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the network connection to the instance. Valid values:'."\n" ."\n" .'* **Internet**'."\n" .'* **Intranet**'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'Internet', ], ], [ 'name' => 'InstanceNetworkType', 'in' => 'query', 'schema' => [ 'description' => 'The network type of the instance. Valid values:'."\n" ."\n" .'* **VPC**'."\n" .'* **Classic**'."\n" ."\n" .'Default value: Classic.'."\n" ."\n" .'> If the instance uses cloud disks, this parameter is required. Set the value to **VPC**. The **VpcId** and **VSwitchId** parameters must be specified when this parameter is set to **VPC**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'VPC', 'default' => 'Classic', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the resource group. The value of this parameter can be NULL.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy*****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'DBInstanceId' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5xxxxxxx', ], 'Message' => [ 'description' => 'The response parameters.'."\n", 'type' => 'string', 'example' => 'success', ], 'OrderId' => [ 'description' => 'The ID of the order.'."\n", 'type' => 'string', 'example' => '20793850608****', ], 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', ], 'TaskId' => [ 'description' => 'The ID of the task.'."\n", 'type' => 'string', 'example' => '417450000', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'RR309', 'errorMessage' => 'We have detected a security risk with your payment method. Please proceed with verification via the link in your email or console message and re-submit your order after verification.', ], [ 'errorCode' => 'GeneralIns.Creating', 'errorMessage' => 'The general instance is creating.', ], [ 'errorCode' => 'InvalidZone.NotSupportedForStorageType', 'errorMessage' => 'The specified zone is closed or invalid for Specified DBInstanceStorageType.', ], [ 'errorCode' => 'GeneralIns.Maintaining', 'errorMessage' => 'The general instance is maintaining.', ], [ 'errorCode' => 'GeneralIns.Switching', 'errorMessage' => 'The general instance is Switching.', ], [ 'errorCode' => 'InvalidEngine.VauleNotSupported', 'errorMessage' => 'The specified parameter "Engine" is not valid.', ], [ 'errorCode' => 'InvalidEngineVersion.ValueNotSupported', 'errorMessage' => 'The specified parameter "EngineVersion" is not valid.', ], [ 'errorCode' => 'InvalidDBinstanceClass.ValueNotSupported', 'errorMessage' => 'The specified parameter DBinstanceClass is invalid.', ], [ 'errorCode' => 'InvalidDBInstanceStorage.ValueNotSupported', 'errorMessage' => 'The specified parameter "DBInstanceStorage" is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceDescription.Malformed', 'errorMessage' => 'The specified parameter "DBInstanceDescription" is not valid.', ], [ 'errorCode' => 'InvalidSecurityIPList.Duplicate', 'errorMessage' => 'Specified security IP list is not valid: Duplicate IP address in the list', ], [ 'errorCode' => 'InvalidSecurityIPListLength.Malformed', 'errorMessage' => 'The quota of security ip exceeds.', ], [ 'errorCode' => 'DefaultVpc.NotSupport', 'errorMessage' => 'The default vpc create is not support.', ], [ 'errorCode' => 'Forbidden.RegionNotFound', 'errorMessage' => 'The provided RegionId does not exist in our record.', ], [ 'errorCode' => 'InvalidVpcIdOrVswitchId.NotSupported', 'errorMessage' => 'The specified vpcId or vSwitchId is not supported.', ], [ 'errorCode' => 'InvalidVpcId.NotSupported', 'errorMessage' => 'The specified vpcId or vSwitchId is not supported.', ], [ 'errorCode' => 'InvalidZoneId.NotSupported', 'errorMessage' => 'The Specified vpc Zone not supported.', ], [ 'errorCode' => 'VswitchIpExhausted', 'errorMessage' => 'No available ip in the specified vswitch.', ], [ 'errorCode' => 'InvalidGeneralGroupName.Malformed', 'errorMessage' => 'The specified parameter GeneralGroupName is not valid.', ], [ 'errorCode' => 'AccountBasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'IncorrecttVpcId', 'errorMessage' => 'The specified parameter VPCId is not valid.', ], [ 'errorCode' => 'OperationDenied.DBInstanceStatus', 'errorMessage' => 'Operation is denied by the current database instance status.', ], [ 'errorCode' => 'InvalidDBInstanceClass.Offline', 'errorMessage' => 'The specified instance type is no longer provided. Please specify another instance type.', ], [ 'errorCode' => 'ZoneId.NotMatchWithCategory', 'errorMessage' => 'The number of available zones does not match the database engine or instance edition. Please reset it.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'InvalidParam.InstanceNetworkType', 'errorMessage' => 'Creation of classic network instances is not supported.', ], ], 403 => [ [ 'errorCode' => 'ClassicNetworkType.NotSupport', 'errorMessage' => 'The Classic instance network create is not support.', ], [ 'errorCode' => 'InvalidEngineVersionInRegion.NotAvailable', 'errorMessage' => 'The EngineVersion in the Region is not available.', ], [ 'errorCode' => 'OperationDenied', 'errorMessage' => 'The specified request is out of resources.', ], [ 'errorCode' => 'QuotaExceeded.CreateInstance', 'errorMessage' => 'The quota of create instance exceeds.', ], [ 'errorCode' => 'Forbidden.Authentication', 'errorMessage' => 'The operation is forbidden by Aliyun Realname Authentication System.', ], [ 'errorCode' => 'INST_HAS_UNPAID_ORDER', 'errorMessage' => 'The instanceId has unpaid order.', ], [ 'errorCode' => 'COMMODITY.FAILED', 'errorMessage' => 'The commodity is error.', ], [ 'errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', ], [ 'errorCode' => 'OperationDenied.ClassicNetworkType', 'errorMessage' => 'The operation is not permitted due to status of instance.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'Invalid DBInstanceId NotFound.', ], [ 'errorCode' => 'CreateOrder.Failed', 'errorMessage' => 'Create Order Failed.', ], [ 'errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', ], [ 'errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'QueryPrice Failed.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DBInstanceId\\": \\"rm-uf6wjk5****\\",\\n \\"Message\\": \\"success\\",\\n \\"OrderId\\": \\"20793850608****\\",\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"TaskId\\": \\"417450000\\"\\n}","type":"json"}]', 'title' => 'CreateDBInstanceForRebuild', 'description' => '### Supported database engines'."\n" ."\n" .'* RDS MySQL'."\n" .'* RDS PostgreSQL'."\n" .'* RDS SQL Server'."\n" .'* RDS MariaDB'."\n" ."\n" .'### References'."\n" ."\n" .'> : Fees are generated if the call is successful. Before you call this operation, carefully read the following documentation:'."\n" ."\n" .'* [Manage ApsaraDB RDS for MySQL instances in the recycle bin](~~96065~~)'."\n" .'* [Manage ApsaraDB RDS for PostgreSQL instances in the recycle bin](~~96752~~)'."\n" .'* [Manage ApsaraDB RDS for SQL Server instances in the recycle bin](~~95669~~)'."\n" .'* [Manage ApsaraDB RDS for MariaDB instances in the recycle bin](~~97131~~)'."\n", ], 'DeleteDBInstance' => [ 'summary' => 'Releases an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5****', ], ], [ 'name' => 'ReleasedKeepPolicy', 'in' => 'query', 'schema' => [ 'description' => 'The policy that is used to retain archived backup files if the instance is released. Default value: None. Valid values:'."\n" ."\n" .'* **None**: No archived backup files are retained.'."\n" .'* **Lastest**: Only the last archived backup file is retained.'."\n" .'* **All**: All archived backup files are retained.'."\n" ."\n" .'> This parameter is supported only for ApsaraDB RDS for MySQL instance with local disks.', 'type' => 'string', 'required' => false, 'example' => 'Lastest', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RegionId' => [ 'description' => 'The region ID of the instance. You can call the [DescribeDBInstanceAttribute](~~26231~~) operation to query region ID of the instance.'."\n", 'type' => 'string', 'example' => 'ap-southeast-1', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '65BDA532-28AF-4122-AA39-B382721EEE64', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'EngineMigration.ActionDisabled', 'errorMessage' => 'Specified action is disabled while custins is in engine migration.', ], [ 'errorCode' => 'OperationDenied.DeletionProtection', 'errorMessage' => 'The operation is not permitted when the instance enabled deletion protection.', ], [ 'errorCode' => 'GuardInstance.ReleaseFail', 'errorMessage' => 'The guard instance release fail.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'MasterInstanceNotExist', 'errorMessage' => 'master instance not exist.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'BackupPropertyNotFound', 'errorMessage' => 'Backup policy not found', ], ], 403 => [ [ 'errorCode' => 'OperationDenied.PrePayTypeNotSupported', 'errorMessage' => 'The operation is not permitted due to pay type of instance.', ], [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], [ 'errorCode' => 'UnsupportedByBlueGreenDeployment', 'errorMessage' => 'Operation prohibited due to blue green deployment.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'Invalid DBInstanceId NotFound.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RegionId\\": \\"ap-southeast-1\\",\\n \\"RequestId\\": \\"65BDA532-28AF-4122-AA39-B382721EEE64\\"\\n}","errorExample":""},{"type":"xml","example":"\\n65BDA532-28AF-4122-AA39-B382721EEE64\\nap-southeast-1\\n","errorExample":"\\n\\n\\t7463B73D-35CC-4D19-A010-6B8D65D242EF\\n\\trds.aliyuncs.com\\n\\tUnsupportedOperation\\n\\tThe specified action is not supported.\\n\\t"}]', 'title' => 'DeleteDBInstance', 'description' => '### Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" .'* MariaDB'."\n" ."\n" .'### References'."\n" ."\n" .'> Note Before you call this operation, read the following documentation and make sure that you fully understand the prerequisites and impacts of this operation.'."\n" ."\n" .'* [Release an ApsaraDB RDS for MySQL instance](~~96057~~)'."\n" .'* [Release an ApsaraDB RDS for PostgreSQL instance](~~96749~~)'."\n" .'* [Release an ApsaraDB RDS for SQL Server instance](~~95662~~)'."\n" .'* [Release an ApsaraDB RDS for MariaDB instance](~~97128~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'RestartDBInstance' => [ 'summary' => 'Restarts an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCzxxxxxx', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the [DescribeDBInstances](~~610396~~) operation to query the ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5xxxxxx', ], ], [ 'name' => 'NodeId', 'in' => 'query', 'schema' => [ 'description' => 'The node ID, which can be used to restart a specified node. You can call the [DescribeDBInstanceHAConfig](~~610434~~) operation to obtain the node ID.'."\n" ."\n" .'> : The secondary instance restart feature is supported for RDS instances that run SQL Server EE on RDS Cluster Edition. For more information, see [Restart a secondary database](~~2411880~~).'."\n", 'type' => 'string', 'required' => false, 'example' => '2614****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '65BDA532-28AF-4122-AA39-B382721EEE64', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'GeneralIns.Creating', 'errorMessage' => 'The general instance is creating.', ], [ 'errorCode' => 'GeneralIns.Maintaining', 'errorMessage' => 'The general instance is maintaining.', ], [ 'errorCode' => 'GeneralIns.Switching', 'errorMessage' => 'The general instance is Switching.', ], [ 'errorCode' => 'InvalidDBInstanceStatus.NotSupport', 'errorMessage' => 'The Specified instance status is not supported to restart instance.', ], [ 'errorCode' => 'InvalidEffectiveTime.SpecialTimeIsNull', 'errorMessage' => 'SpecialTime is not valid.', ], [ 'errorCode' => 'IncorrectDBInstanceLockMode.ValueNotSupported', 'errorMessage' => 'The Current DB instance lock mode does not support this operation.', ], [ 'errorCode' => 'InvalidDBInstanceName.Format', 'errorMessage' => 'Specified DB instance name is not valid.', ], [ 'errorCode' => 'MGRMasterNodeRestart.Unsupported', 'errorMessage' => 'Specific primary node is not supported to restart in MGR instance.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'IncorrectRestartMethod', 'errorMessage' => 'The specified RestartMethod params is not valid.', ], [ 'errorCode' => 'IncorrectEffectiveTime', 'errorMessage' => 'The specified EffectiveTime params is not valid.', ], [ 'errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'IncorrectDBInstanceCharacterType', 'errorMessage' => 'Current DB Instance character_type does not support this operation.', ], [ 'errorCode' => 'InvalidRestartPolicy.Format', 'errorMessage' => 'Specified Restart Policy is not valid.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', ], [ 'errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance does not exist or is not supported.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], [ 'errorCode' => 'InvalidNodeId.NotFound', 'errorMessage' => 'The target node does not exist in the current instance.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"65BDA532-28AF-4122-AA39-B382721EEE64\\"\\n}","type":"json"}]', 'title' => 'RestartDBInstance', 'description' => '### Supported database engines'."\n" ."\n" .'* RDS MySQL'."\n" .'* RDS PostgreSQL'."\n" .'* RDS SQL Server'."\n" .'* RDS MariaDB'."\n" ."\n" .'### References'."\n" ."\n" .'> : Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.'."\n" ."\n" .'* [Restart an ApsaraDB RDS for MySQL instance](~~96051~~)'."\n" .'* [Restart an ApsaraDB RDS for PostgreSQL instance](~~96798~~)'."\n" .'* [Restart an ApsaraDB RDS for SQL Server instance](~~95656~~)'."\n" .'* [Restart an ApsaraDB RDS for MariaDB instance](~~97472~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'StopDBInstance' => [ 'summary' => 'Suspends an ApsaraDB RDS instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-bp1q915x50h******', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'A417FB41-A3D9-464E-AD0A-C7FE05C72E98', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidStatus.Format', 'errorMessage' => 'Specified Status is not valid', ], [ 'errorCode' => 'EngineNotSupported', 'errorMessage' => 'The engine does not support the operation.', ], [ 'errorCode' => 'ReadOnlyInstanceNotSupport', 'errorMessage' => 'Specified ReadOnly Instance not support this operation.', ], [ 'errorCode' => 'InvalidShareInstance.NotSupport', 'errorMessage' => 'The share dbInstance is not support.', ], [ 'errorCode' => 'ReadonlyInstanceNotSupport', 'errorMessage' => 'The operation is not permitted due to type of the instance.', ], [ 'errorCode' => 'InstanceHasReadOnlyInstanceNotSupportStop', 'errorMessage' => 'The instance has read-only instance , stop is not supported', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A417FB41-A3D9-464E-AD0A-C7FE05C72E98\\"\\n}","errorExample":""},{"type":"xml","example":"\\n A417FB41-A3D9-464E-AD0A-C7FE05C72E98\\n","errorExample":""}]', 'title' => 'StopDBInstance', 'description' => '### Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" ."\n" .'### References'."\n" ."\n" .'> Before you call this operation, read the following documentation and make sure that you fully understand the prerequisites and impacts of this operation.'."\n" ."\n" .' [Suspend an ApsaraDB RDS for SQL Server instance](~~462504~~)', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'StartDBInstance' => [ 'summary' => 'Resumes an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'DedicatedHostGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The dedicated cluster ID. This parameter is supported if you call this operation to suspend an RDS instance in the dedicated cluster. You can call the DescribeDedicatedHostGroups operation to query the dedicated cluster ID.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'dhg-39****', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-bp****', ], ], [ 'name' => 'TargetDedicatedHostIdForMaster', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the host on which the primary instance is created. This parameter is available only for instances that are created in dedicated clusters.'."\n" ."\n" .'> This parameter must be specified when **DBInstanceTransType** is set to **2**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'dh-bp****', ], ], [ 'name' => 'TargetDedicatedHostIdForSlave', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the host on which the secondary instance is created. This parameter is available only for instances that are created in dedicated clusters.'."\n" ."\n" .'> This parameter must be specified when **DBInstanceTransType** is set to **2**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'dh-bp****', ], ], [ 'name' => 'TargetDedicatedHostIdForLog', 'in' => 'query', 'schema' => [ 'description' => 'A deprecated parameter. You do not need to specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'dh-bp****', ], ], [ 'name' => 'EffectiveTime', 'in' => 'query', 'schema' => [ 'description' => 'The effective time. This parameter is available only for instances that are created in dedicated clusters.'."\n" ."\n" .'* **Immediate**'."\n" .'* **MaintainTime**: The change takes effect during the planned maintenance window. For more information, see ModifyDBInstanceMaintainTime.'."\n" .'* **SpecificTime**: The change takes effect at a specified point in time.'."\n" ."\n" .'Default value: MaintainTime.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Immediate', ], ], [ 'name' => 'SpecifiedTime', 'in' => 'query', 'schema' => [ 'description' => 'The switching time. This parameter is available only for instances that are created in dedicated clusters. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n" ."\n" .'> This parameter must be specified when **EffectiveTime** is set to **Specified**.'."\n", 'type' => 'string', 'required' => false, 'example' => '2019-10-21T10:00:00Z', ], ], [ 'name' => 'TargetDBInstanceClass', 'in' => 'query', 'schema' => [ 'description' => 'The instance type of the required instance. This parameter is available only for instances that are created in dedicated clusters.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rds.ebmhfc6.20xlarge', ], ], [ 'name' => 'EngineVersion', 'in' => 'query', 'schema' => [ 'description' => 'The database engine version of the instance. This parameter is available only for instances that are created in dedicated clusters.'."\n", 'type' => 'string', 'required' => false, 'example' => '5.7', ], ], [ 'name' => 'DBInstanceTransType', 'in' => 'query', 'schema' => [ 'description' => 'The data migration method of the instance. This parameter is available only for instances that are created in dedicated clusters. Valid values:'."\n" ."\n" .'* **0** (default): The system preferentially upgrades or downgrades the instance without a migration. If the resources on the host on which the instance resides are insufficient, the system migrates the instance to another suitable host.'."\n" .'* **1**: The system upgrades or downgrades the instance without a migration. If the upgrade or downgrade is not supported, the system reports an error.'."\n" .'* **2**: The system migrates the data of the instance from the host on which the instance resides to another host. You must also specify **DedicatedHostGroupId**, **TargetDedicatedHostIdForMaster**, and **TargetDedicatedHostIdForSlave**. If you set DBInstanceTransType to 2, you cannot migrate the data of the instance to the host on which the instance resides. If you migrate the data of the instance to the host on which the instance resides, the migration fails.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], ], [ 'name' => 'Storage', 'in' => 'query', 'schema' => [ 'description' => 'The storage capacity of the instance. This parameter is available only for instances that are created in dedicated clusters. Valid values: **5 to 2000**. Unit: GB. If you do not specify this parameter, the storage capacity of the instance remains unchanged.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1000', ], ], [ 'name' => 'VSwitchId', 'in' => 'query', 'schema' => [ 'description' => 'The vSwitch ID. This parameter is available only for instances that are created in dedicated clusters.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vsw-****', ], ], [ 'name' => 'ZoneId', 'in' => 'query', 'schema' => [ 'description' => 'The zone ID. This parameter is available only for instances that are created in dedicated clusters.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-a', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'MigrationId' => [ 'description' => 'The migration task ID. This parameter is available only for instances that are created in dedicated clusters.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '740', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'A417FB41-A3D9-464E-AD0A-C7FE05C72E98', ], 'TaskId' => [ 'description' => 'The ID of the task.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '238028563', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidStatus.Format', 'errorMessage' => 'Specified Status is not valid', ], [ 'errorCode' => 'UnsupportExtendDisk.NotSupport', 'errorMessage' => 'Specified DB instance is unsupport extend disk.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"MigrationId\\": 740,\\n \\"RequestId\\": \\"A417FB41-A3D9-464E-AD0A-C7FE05C72E98\\",\\n \\"TaskId\\": 238028563\\n}","errorExample":""},{"type":"xml","example":"\\n A417FB41-A3D9-464E-AD0A-C7FE05C72E98\\n 238028563\\n","errorExample":""}]', 'title' => 'StartDBInstance', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> Before you call this operation, read the following topics and make sure that you fully understand the prerequisites and impacts of this operation.'."\n" ."\n" .'[Start an ApsaraDB RDS for SQL instance](~~462504~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ModifyDBInstanceSpec' => [ 'summary' => 'Changes the instance type and storage capacity of an ApsaraDB RDS instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'paid', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the [DescribeDBInstances](~~610396~~) operation to query the instance IDs.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5*******', ], ], [ 'name' => 'DBInstanceClass', 'in' => 'query', 'schema' => [ 'description' => 'The instance type of the new instance. For more information, see [Specifications](~~26312~~). You can call the [DescribeAvailableClasses](~~610393~~) operation to query the instance types.'."\n" ."\n" .'> * You must specify at least one of DBInstanceClass and **DBInstanceStorage**.'."\n" .'> * You can call the [DescribeDBInstanceAttribute](~~610394~~) operation to query the current instance type of the instance.', 'type' => 'string', 'required' => false, 'example' => 'rds.mys2.small', ], ], [ 'name' => 'DBInstanceStorage', 'in' => 'query', 'schema' => [ 'description' => 'The storage capacity of the new instance. Unit: GB. For more information, see [Storage types](~~26312~~). You can call the [DescribeAvailableClasses](~~610393~~) operation to query the storage capacity range that is supported by the new instance type.'."\n" ."\n" .'> * You must specify at least one of DBInstanceStorage and **DBInstanceClass**.'."\n" .'> * You can call the [DescribeDBInstanceAttribute](~~610394~~) operation to query the current storage capacity of the instance.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '32000', 'minimum' => '5', 'example' => '20', ], ], [ 'name' => 'PayType', 'in' => 'query', 'schema' => [ 'description' => 'The billing method of the instance. Valid values:'."\n" ."\n" .'* **Postpaid**: pay-as-you-go.'."\n" .'* **Prepaid**: subscription.'."\n" .'* **Serverless**: serverless. This value is not supported for ApsaraDB RDS for MariaDB instances.'."\n" ."\n" .'> If you want to set this parameter to Serverless, **you must specify **AutoPause, MaxCapacity, MinCapacity, and SwitchForce. For more information, see [Overview of serverless ApsaraDB RDS for MySQL instances](~~411291~~), [Overview of serverless ApsaraDB RDS for SQL Server instances](~~604344~~), and [Overview of serverless ApsaraDB RDS for PostgreSQL instances](~~607742~~).'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'Postpaid', ], ], [ 'name' => 'EffectiveTime', 'in' => 'query', 'schema' => [ 'description' => 'The time when the new specifications take effect. Valid values:'."\n" ."\n" .'> **Specific changes may affect the instance**. Read the [Impact](~~96061~~) section before you specify this parameter. We recommend that you specify this parameter during off-peak hours.'."\n" ."\n" .'* **Immediate** (default): The changes immediately take effect.'."\n" .'* **MaintainTime**: The changes take effect during the [maintenance window](~~610402~~) of the instance.'."\n" .'* **ScheduleTime**: The changes take effect at the point in time that you specify. This time must be at least 12 hours later than the current time. The actual effective time is calculated based on the following formula: EffectiveTime = ScheduleTime + SwitchTime.'."\n", 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'ScheduleTime' => '', ], 'example' => 'MaintainTime', 'default' => 'Immediate', ], ], [ 'name' => 'EngineVersion', 'in' => 'query', 'schema' => [ 'description' => 'The database engine version of the instance. Valid values:'."\n" ."\n" .'**Regular RDS instances**'."\n" ."\n" .'* Valid values when Engine is set to MySQL: 5.5, 5.6, 5.7, and 8.0.'."\n" .'* Valid values when Engine is set to SQLServer: 2008r2, 08r2\\_ent_ha, 2012, 2012\\_ent_ha, 2012\\_std_ha, 2012\\_web, 2014\\_std_ha, 2016\\_ent_ha, 2016\\_std_ha, 2016\\_web, 2017\\_std_ha, 2017\\_ent, 2019\\_std_ha, and 2019\\_ent.'."\n" .'* Valid values when Engine is set to PostgreSQL: 10.0, 11.0, 12.0, 13.0, 14.0, and 15.0.'."\n" .'* Valid value when Engine is set to MariaDB: 10.3.'."\n" ."\n" .'**Serverless instances. ApsaraDB RDS for MariaDB does not support serverless instances.**'."\n" ."\n" .'* Valid values when Engine is set to MySQL: 5.7 and 8.0.'."\n" .'* Valid values when Engine is set to SQL Server: 2016\\_std_sl, 2017\\_std_sl, and 2019\\_std_sl.'."\n" .'* Valid values when Engine is set to PostgreSQL: 14.0, 15.0, and 16.0.'."\n", 'type' => 'string', 'required' => false, 'example' => '5.6', ], ], [ 'name' => 'DBInstanceStorageType', 'in' => 'query', 'schema' => [ 'description' => 'The storage type of the new instance. Valid values:'."\n" ."\n" .'* **local_ssd**: local SSD.'."\n" .'* **cloud_ssd**: SSD cloud disks. This storage medium is not recommended and is unavailable in specific Alibaba Cloud regions.'."\n" .'* **cloud_essd**: performance level 1 (PL1) Enterprise SSD (ESSD).'."\n" .'* **cloud_essd2**: PL2 ESSD.'."\n" .'* **cloud_essd3**: PL3 ESSD.'."\n" ."\n" .'To change the storage type, take note of the following items:'."\n" ."\n" .'If the instance runs PostgreSQL, you can upgrade the storage type of the instance from standard SSDs to ESSDs. However, you cannot downgrade the storage type of the instance from ESSDs to standard SSDs. ESSDs provide the following PLs: ESSDs of PL1, ESSDs of PL2, and ESSDs of PL3. You can upgrade or downgrade the storage type between ESSD of PL1, ESSD of PL2, and ESSD of PL3. For more information, see [Configuration items](~~96750~~).', 'type' => 'string', 'required' => false, 'example' => 'local_ssd', ], ], [ 'name' => 'ReadOnlyDBInstanceClass', 'in' => 'query', 'schema' => [ 'title' => 'Mysql高可用本地盘实例变配云盘时的只读实例目标规格', 'description' => 'The specification of the read-only instance when you change the storage type of the ApsaraDB RDS for MySQL instance that runs RDS High-availability Edition from cloud disk to local disk.'."\n", 'type' => 'string', 'required' => false, 'example' => 'mysqlro.n2.large.c', ], ], [ 'name' => 'Direction', 'in' => 'query', 'schema' => [ 'description' => 'The type of change that you want to perform on the instance. Valid values:'."\n" ."\n" .'* **Up** (default): upgrades a subscription instance, or upgrades or downgrades a pay-as-you-go instance.'."\n" .'* **Down**: downgrades a subscription instance.'."\n" .'* **TempUpgrade**: performs auto scaling on a subscription instance that runs SQL Server. This value is required for auto scaling.'."\n" .'* **Serverless**: modifies the auto scaling settings of a serverless instance.'."\n" ."\n" .'> If you specify only **DBInstanceStorageType**, you can leave Direction empty. For example, if you want to change only the storage type of the instance from standard SSD to Enterprise SSD (ESSD), you do not need to specify Direction.'."\n", 'type' => 'string', 'required' => false, 'enumValueTitles' => [], 'example' => 'Up', 'default' => 'Auto', 'enum' => [ 'Up', 'Down', 'Auto', 'TempUpgrade', 'Serverless', ], ], ], [ 'name' => 'SourceBiz', 'in' => 'query', 'schema' => [ 'description' => 'A deprecated parameter. You do not need to specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Specifies whether to enable the automatic suspension feature.'."\n", ], ], [ 'name' => 'DedicatedHostGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the dedicated cluster.'."\n", 'type' => 'string', 'required' => false, 'example' => 'dhg-7a9********', ], ], [ 'name' => 'ZoneId', 'in' => 'query', 'schema' => [ 'description' => 'The RDS edition of the instance. Valid values:'."\n" ."\n" .'* **Basic**: RDS Basic Edition.'."\n" .'* **HighAvailability**: RDS High-availability Edition.'."\n" .'* **AlwaysOn**: RDS Cluster Edition for SQL Server.'."\n" .'* **Finance**: RDS Enterprise Edition. This edition is available only on the China site (aliyun.com).'."\n" ."\n" .'> If you set **EngineVersion** to an SQL Server version number, you must also specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-b', ], ], [ 'name' => 'SwitchTime', 'in' => 'query', 'schema' => [ 'description' => 'The time at which you want to change the specifications. **We recommend that you perform the specification changes during off-peak hours.**'."\n" ."\n" .'Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time must be in UTC.'."\n" ."\n" .'> * The time at which you want to change the specifications **must be later than the current time**. Otherwise, the specification change task fails. If the specification change task fails, you must wait for the order to be automatically canceled, and then call this operation again.'."\n" .'> * If you want to increase the storage capacity or change the ESSD storage type between different PLs, the specification change immediately takes effect and does not affect your workloads. You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => '2019-07-10T13:15:12Z', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'title' => '资源组名称', 'description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy**********', ], ], [ 'name' => 'UsedTime', 'in' => 'query', 'schema' => [ 'description' => 'The validity period of the specification changes on an ApsaraDB RDS for SQL Server instance. At the end of the validity period, the specifications of the instance are restored to the specifications that are used before an [elastic upgrade](~~95665~~) is performed. Unit: days.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3', ], ], [ 'name' => 'ServerlessConfiguration', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The specifications that you want to change for a serverless instance.'."\n", 'type' => 'object', 'properties' => [ 'AutoPause' => [ 'description' => 'Specifies whether to enable the automatic start and stop feature for the serverless instance that runs MySQL or PostgreSQL. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false** (default)'."\n" ."\n" .'> After the automatic start and stop feature is enabled, if no connections to the instance are established within 10 minutes, the instance is suspended. After a connection to the instance is established, the instance is automatically resumed.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false', ], 'MaxCapacity' => [ 'description' => 'The **maximum** number of RDS Capacity Units (RCUs). Valid values:'."\n" ."\n" .'* Serverless ApsaraDB RDS for MySQL instances: **1 to 32**'."\n" .'* Serverless ApsaraDB RDS for SQL Server instances: **2 to 16**. Only integers are supported.'."\n" .'* Serverless ApsaraDB RDS for PostgreSQL instances: **1 to 14**'."\n" ."\n" .'> The value of this parameter must be greater than or equal to the value of **MinCapacity**.'."\n", 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '8', ], 'MinCapacity' => [ 'description' => 'The minimum number of RCUs. Valid values:****'."\n" ."\n" .'* Serverless ApsaraDB RDS for MySQL instances: **0.5 to 32**.'."\n" .'* Serverless ApsaraDB RDS for SQL Server instances: **2 to 8**. Only integers are supported.'."\n" .'* Serverless ApsaraDB RDS for PostgreSQL instances: **0.5 to 14**.'."\n" ."\n" .'> The value of this parameter must be less than or equal to the value of MaxCapacity.'."\n", 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '0.5', ], 'SwitchForce' => [ 'description' => 'Specifies whether to enable the forceful scaling feature for the serverless instance that runs MySQL or PostgreSQL. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false** (default)'."\n" ."\n" .'> '."\n" ."\n" .'* If you set this parameter to true, **a service interruption that lasts 30 to 120 seconds occurs during forced scaling**. Process with caution.'."\n" ."\n" .'* The RCU scaling for a serverless instance immediately takes effect. In some cases, such as the execution of large transactions, the scaling does not immediately take effect. In this case, you can enable this feature to forcefully scale the RCUs of the instance.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false', ], ], 'required' => false, ], ], [ 'name' => 'Category', 'in' => 'query', 'schema' => [ 'description' => 'The RDS edition of the instance. Valid values:'."\n" ."\n" .'> If you set **EngineVersion** to an SQL Server version number, you must also specify this parameter.'."\n" ."\n" .'**Regular RDS instances**'."\n" ."\n" .'* **Basic**: RDS Basic Edition.'."\n" .'* **HighAvailability**: RDS High-availability Edition.'."\n" .'* **AlwaysOn**: RDS Cluster Edition for ApsaraDB RDS for SQL Server.'."\n" .'* **Cluster**: RDS Cluster Edition for ApsaraDB RDS for MySQL.'."\n" ."\n" .'**Serverless instances. ApsaraDB RDS for MariaDB does not support serverless instances.**'."\n" ."\n" .'* **serverless_basic**: RDS Basic Edition. This edition is available only for serverless instances that run MySQL and PostgreSQL.'."\n" .'* **serverless_standard**: RDS High-availability Edition. This edition is available only for serverless instances that run MySQL and PostgreSQL.'."\n" .'* **serverless_ha**: RDS High-availability Edition for serverless instances. This edition is available only for instances that run SQL Server.', 'type' => 'string', 'required' => false, 'example' => 'HighAvailability', ], ], [ 'name' => 'BurstingEnabled', 'in' => 'query', 'schema' => [ 'description' => 'An invalid parameter. You do not need to specify this parameter.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'AutoUseCoupon', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to use vouchers to offset fees. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false** (default)'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'true', ], ], [ 'name' => 'TargetMinorVersion', 'in' => 'query', 'schema' => [ 'description' => 'The minor engine version number of the ApsaraDB RDS for PostgreSQL instance. For more information, see [Update the minor engine version](~~126002~~). If the minor engine version does not support changing the instance type, you must specify the minor engine version to **update the minor engine version when you change the instance type**.'."\n" ."\n" .'Format: `rds_postgres_00_`. For example, if the instance runs PostgreSQL 12, set this parameter to `rds_postgres_1200_20200830`.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rds_postgres_1200_20200830', ], ], [ 'name' => 'IoAccelerationEnabled', 'in' => 'query', 'schema' => [ 'description' => 'A reserved parameter.', 'type' => 'string', 'required' => false, 'example' => 'None', ], ], [ 'name' => 'ColdDataEnabled', 'in' => 'query', 'schema' => [ 'description' => 'A reserved parameter.', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'ZoneIdSlave1', 'in' => 'query', 'schema' => [ 'description' => 'The zone ID of the secondary instance. If you set this parameter to the same value as **ZoneId**, the single-zone deployment method is used. If you set this parameter to a different value from **ZoneId**, the multi-zone deployment method is used.'."\n" ."\n" .'> If you want to upgrade the major engine version of an ApsaraDB RDS for SQL Server instance by specifying AllowMajorVersionUpgrade or change the secondary zone, you must specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-c', ], ], [ 'name' => 'VSwitchId', 'in' => 'query', 'schema' => [ 'description' => 'The vSwitch ID. The vSwitch must belong to the zone that is specified by **ZoneId**.'."\n" ."\n" .'* If you set **InstanceNetworkType** to **VPC**, you must also specify this parameter.'."\n" .'* If you specify ZoneSlaveId1, you must specify the IDs of two vSwitches for this parameter and separate the IDs with a comma (,).'."\n" ."\n" .'> If you want to upgrade the major engine version of an ApsaraDB RDS for SQL Server instance by specifying AllowMajorVersionUpgrade or change the vSwitch, you must specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vsw-bp1oxflciovg9l7163lr7', ], ], [ 'name' => 'AllowMajorVersionUpgrade', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to upgrade the major engine version of an ApsaraDB RDS for SQL Server instance. For more information, see [Upgrade the major engine version](~~127458~~). Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false** (default)'."\n" ."\n" .'> * When you upgrade the major engine version, you must also specify the required parameters such as DBInstanceId, EngineVersion, DBInstanceClass, Category, ZoneId, and VSwitchId.'."\n" .'> * If you want to upgrade the instance edition to RDS High-availability Edition or RDS Cluster Edition, you must specify ZoneIdSlave1.', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'PromotionCode', 'in' => 'query', 'schema' => [ 'description' => 'The coupon code.'."\n", 'type' => 'string', 'required' => false, 'example' => '723298850895', ], ], [ 'name' => 'OptimizedWrites', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable the write optimization feature for the ApsaraDB RDS for MySQL instance. For more information, see [Use the write optimization feature](~~2858761~~). Valid values:'."\n" ."\n" .'* **optimized**: enables the feature.'."\n" .'* **none**: disables the feature.'."\n", 'type' => 'string', 'required' => false, 'example' => 'optimized', 'enum' => [ 'optimized', 'none', ], ], ], [ 'name' => 'CompressionMode', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable the storage compression feature for the ApsaraDB RDS for MySQL instance. For more information, see [Use the storage compression feature](~~2861985~~). Valid values:'."\n" ."\n" .'* **on**'."\n" .'* **off**'."\n", 'type' => 'string', 'required' => false, 'example' => 'on', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'DBInstanceId' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5*******', ], 'OrderId' => [ 'description' => 'The ID of the order.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '20793850608****', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '3C5CFDEE-F774-4DED-89A2-1D76EC63C575', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'UnsupportedReduceDiskSize', 'errorMessage' => '%s%s', ], [ 'errorCode' => 'CannotDecreaseEssdPerfLevel', 'errorMessage' => 'cannot decrease cloud essd performance level.', ], [ 'errorCode' => 'InvalidEssdStorageSize', 'errorMessage' => 'invalid cloud essd storage size.', ], [ 'errorCode' => 'Postpaid.NotSupport', 'errorMessage' => 'Postpaid not supported.', ], [ 'errorCode' => 'InvalidConcurrentOperate', 'errorMessage' => 'System concurrent operate.', ], [ 'errorCode' => 'NotSupportReduceDiskSize', 'errorMessage' => 'Not support reduce disk size.', ], [ 'errorCode' => 'IncorrectStorageType', 'errorMessage' => 'Incorrect storage type.', ], [ 'errorCode' => 'TargetStorageLessThanBottomLine', 'errorMessage' => 'Target storage less than bottom line', ], [ 'errorCode' => 'InstanceHasUnpaidOrder', 'errorMessage' => 'The specified Instance has unpaid order.', ], [ 'errorCode' => 'InsufficientBalance', 'errorMessage' => 'Open volume paid cloud database. Your account balance is less than 100 RMB. Top-up and try again.', ], [ 'errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'Specified DB instance class is not found.', ], [ 'errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter "%s" is not valid.', ], [ 'errorCode' => 'InvalidAvZone.Format', 'errorMessage' => 'Specified AvZone is not valid.', ], [ 'errorCode' => 'OperationDenied.OrderUnPaid', 'errorMessage' => 'The operation is not permitted due to the wrong Order status (Unpaid).', ], [ 'errorCode' => 'OperationDenied.InvalidStorageSize', 'errorMessage' => 'The storage size limit is exceeded.', ], [ 'errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The instance cluster does not support this operation.', ], [ 'errorCode' => 'InvalidUsedTime', 'errorMessage' => 'The parameter usedTime is invalid.', ], [ 'errorCode' => 'CannotChangeStorageType', 'errorMessage' => 'Temp upgrade does not support changing storage type.', ], [ 'errorCode' => 'TempUpgrade.NotSupport', 'errorMessage' => 'The instance does not support temp upgrade.', ], [ 'errorCode' => 'EngineNotSupported', 'errorMessage' => 'Engine specified cannot be supported the operation.', ], [ 'errorCode' => 'MaxscaleNotSupport', 'errorMessage' => 'Maxscale not supported', ], [ 'errorCode' => 'ADInstanceNotSupportThisOperation', 'errorMessage' => 'The AD instance is not supported this operation', ], [ 'errorCode' => 'BYOKInstanceNotSupportThisOperation', 'errorMessage' => 'The BYOK instance is not supported this operation', ], [ 'errorCode' => 'BYOLInstanceNotSupportThisOperation', 'errorMessage' => 'The BYOL instance is not supported this operation', ], [ 'errorCode' => 'SSLInstanceNotSupportThisOperation', 'errorMessage' => 'The instance opened SSL, upgrade is not this operation', ], [ 'errorCode' => 'TDEInstanceNotSupportThisOperation', 'errorMessage' => 'The instance opened TDE, this operation is not supported', ], [ 'errorCode' => 'InstanceIsSnapshotBackupNotSupportThisOperation', 'errorMessage' => 'The instance backup method is snapshot backup, this operation is not supported', ], [ 'errorCode' => 'InstanceHasReadOnlyInstanceNotSupportThisOperation', 'errorMessage' => 'The instance has read-only instance or is read-only instance, this operation is not supported', ], [ 'errorCode' => 'InvalidTargetStorageType', 'errorMessage' => 'Can not change storage type when modify instance class or storage.', ], [ 'errorCode' => 'InvalidTargetCategory', 'errorMessage' => 'Specified classcode is not matched with current product type.', ], [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', ], [ 'errorCode' => 'BackupReadInstanceModifyNotAllowed', 'errorMessage' => 'Modify Backup Read Instance Is Not Allowed.', ], [ 'errorCode' => 'MinorVersionNotSupport', 'errorMessage' => 'The current database minor version does not support the operation.', ], [ 'errorCode' => 'LX.ARGUMENT.ILLEGAL', 'errorMessage' => '变配，当前实例无有效配置', ], [ 'errorCode' => 'ORD.S.QUERY.PROD.ERROR', 'errorMessage' => 'An error occurred while querying the ordering information', ], [ 'errorCode' => 'InvalidParameter.NotSupportDiskTypeModify', 'errorMessage' => 'Serverless not support modify disk type!', ], [ 'errorCode' => 'InvalidParameter.NotSupportModifyServerlessConfigAndDiskTogether', 'errorMessage' => 'Serverless not support modify serverlessconfig and disk together!', ], [ 'errorCode' => 'InvalidParameters.Malformed', 'errorMessage' => 'One or more of the request parameters provided are not valid.', ], [ 'errorCode' => 'DBInstancePayTypeNotSupport', 'errorMessage' => 'Current instance PayType not support this operation or the param PayType not match current instance PayType.', ], [ 'errorCode' => 'InvalidDBInstanceClass.Offline', 'errorMessage' => 'The specified instance type is no longer provided. Please specify another instance type.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidPayType.NotSupported', 'errorMessage' => 'current instance pay type not support this operation.', ], [ 'errorCode' => 'OperationDenied.DurationLimit', 'errorMessage' => 'The duration between two operations should be greater than specified time.', ], [ 'errorCode' => 'AccountMoneyValidate.error', 'errorMessage' => 'Insufficient funds available in the account.', ], [ 'errorCode' => 'ChangeEngineVersionNotSupported', 'errorMessage' => 'This operation does not support modifying the engine version.', ], [ 'errorCode' => 'InvalidDBInstanceStorageType', 'errorMessage' => 'The specified DBInstanceStorageType is invalid.', ], [ 'errorCode' => 'EncryptionInstancesNotSupport', 'errorMessage' => 'Cloud disk encryption instances that use byok do not support modify to multi tenant.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'CurrentInsHasColdDB', 'errorMessage' => 'The current instance has cold storage db.', ], [ 'errorCode' => 'CurrentInsHasColdStorage', 'errorMessage' => 'Current instance has cold storage.', ], [ 'errorCode' => 'InsufficientResourceCapacityCheck', 'errorMessage' => 'There is insufficient capacity available for the requested instance with precheck.', ], [ 'errorCode' => 'InvalidStorageSize.Direction', 'errorMessage' => 'The specified parameter StorageSize does not meet the updating direction constraint requirements.', ], [ 'errorCode' => 'InvalidStorageType.Direction', 'errorMessage' => 'The specified parameter StorageType does not meet the updating direction constraint requirements.', ], [ 'errorCode' => 'EngineNotSupportShrinkStorage', 'errorMessage' => 'The current engine does not support shrinking storage space.', ], [ 'errorCode' => 'InvalidSourceCategory', 'errorMessage' => 'specified source category is invalid.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidRCUValue', 'errorMessage' => 'scaleMin and scaleMax range is not valid.', ], [ 'errorCode' => 'ServiceLinkedRole.NotExist', 'errorMessage' => 'SLR does not exist, you needs to create SLR first.', ], [ 'errorCode' => 'ParamGroupOptionValue.NotSupport', 'errorMessage' => 'Specified option value unsupported.', ], [ 'errorCode' => 'CreateUpgradeOrderBusinessException', 'errorMessage' => 'The parameter is illegal or empty.', ], [ 'errorCode' => 'InvalidReadDBInstanceStorage.Format', 'errorMessage' => 'Specified Storage is not valid, Read DB Instance storage size must be greater than or equal to primary DB Instance.', ], [ 'errorCode' => 'UnsupportedModifyParam', 'errorMessage' => 'Burst param must be only modified.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidRequestId', 'errorMessage' => 'The request is copy, check your token.', ], [ 'errorCode' => 'UnsupportExtendDisk.NotSupport', 'errorMessage' => 'Specified DB instance is unsupport extend disk.', ], [ 'errorCode' => 'Order.InstHasUnsettledBills', 'errorMessage' => 'You currently have outstanding bills, please settle them first.', ], [ 'errorCode' => 'CheckAllowMajorVersionUpgradeFailed', 'errorMessage' => 'We have detected that you want to upgrade the version of the instance, but the parameter allowMajorVersionUpgrade is false. If you want to upgrade the version of the instance, please set the parameter allowMajorVersionUpgrade to true.', ], [ 'errorCode' => 'IncorrectDBSslStatus', 'errorMessage' => 'Specified DB SSLStatus does not support this operation.', ], [ 'errorCode' => 'UpgradeEngineVersionCannotChangeStorage', 'errorMessage' => 'Upgrade engine version can not change storage size.', ], [ 'errorCode' => 'ReadOnlyInsNotSupported', 'errorMessage' => 'Instances containing read-only instances do not allow this operation.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'InvalidDBInstanceClass.NotSupport', 'errorMessage' => 'The target primary db instance class can not lower than the original primary db instance class.', ], [ 'errorCode' => 'InvalidPayType.NotSame', 'errorMessage' => 'All primary and read-only instances should have the same payment type.', ], [ 'errorCode' => 'InvalidReadOnlyDBInstanceClass.NotSupport', 'errorMessage' => 'The target read-only db instance class can not lower than the original read-only db instance class.', ], [ 'errorCode' => 'InvalidStorageSize.CannotChange', 'errorMessage' => 'Can not change storage size in this operation. If you need to change disk type, please change storage size first, and the storage size must meet your target disk type\'s constraint requirements.', ], [ 'errorCode' => 'InvalidStorageSize.ConstraintUnsatisfied', 'errorMessage' => 'The db instance\'s storage size dose not meet the constraint requirements of the parameter DBInstanceStorageType. If you still want to change disk type, please change storage size to meet the target disk type\'s constraint in other operation.', ], [ 'errorCode' => 'ReadonlyDBInstanceClassEmpty', 'errorMessage' => 'The read-only target instance class should not be empty.', ], [ 'errorCode' => 'ReadonlyDBInstanceClassNotSame', 'errorMessage' => 'All readonly db instances should have the same instance class.', ], [ 'errorCode' => 'StopService.ModifyDBInstanceSpec', 'errorMessage' => 'The service has been discontinued and does not permit resizing operations on instances using the classic network.', ], [ 'errorCode' => 'InvalidParam.DiskSize', 'errorMessage' => '%s.', ], [ 'errorCode' => 'InvalidOrder.NotFound', 'errorMessage' => 'Specified order does not exist in RDS.', ], [ 'errorCode' => 'NotFindAvailableVswitch', 'errorMessage' => 'Secondary zone, no available switch found under the current vpc.', ], [ 'errorCode' => 'InvalidStorageType.NotSupport', 'errorMessage' => 'The current storage type does not support this operation.', ], [ 'errorCode' => 'IncorrectReadDBInstanceMemSize', 'errorMessage' => 'The instance type of read-only instance is too small.', ], [ 'errorCode' => 'DBInstanceNotServerless', 'errorMessage' => 'The dbinstance is not serverless.', ], [ 'errorCode' => 'UnSupportDbTypeReduceDiskSize', 'errorMessage' => 'The current instance does not support scale-in.', ], [ 'errorCode' => 'ClassicNetDisabled', 'errorMessage' => 'The classic network address is currently disabled, and the instance cannot perform configuration changes.', ], [ 'errorCode' => 'SecondaryAddrNotSupportThisOperation', 'errorMessage' => 'The instance has a secondary instance address, so updates are not allowed.', ], ], 403 => [ [ 'errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'The database instance type does not support the operation.', ], [ 'errorCode' => 'OperationDenied.NotSupportedBackupMethod', 'errorMessage' => 'When the storage is larger than 4000 GB, only snapshot backup is supported.', ], [ 'errorCode' => 'IncorrectReadDBInstanceDisksize', 'errorMessage' => 'Read instance disk size must be equal or higher than primary instance.', ], [ 'errorCode' => 'BetaServerlessNotSupportThisAction', 'errorMessage' => 'Beta Serverless Not Support This Feature', ], [ 'errorCode' => 'GroupReplicationNotSupport.InvalidEngineVersion', 'errorMessage' => 'Group Replication requires the instance engine version to be 8.0.', ], [ 'errorCode' => 'GroupReplicationNotSupport.InvalidNodeClassCode', 'errorMessage' => 'Group Replication requires the ClassCode of each node to be consistent.', ], [ 'errorCode' => 'GroupReplicationNotSupport.InvalidNodeNum', 'errorMessage' => 'Group Replication is not supported, the number of nodes must be an odd number greater than or equal to 3.', ], [ 'errorCode' => 'GroupReplicationNotSupport.InvalidXengine', 'errorMessage' => 'Group Replication is not supported because the instance has xengine tables.', ], [ 'errorCode' => 'GroupReplicationNotSupport.MemoryTooSmall', 'errorMessage' => 'Group Replication is not supported because the memory is too small.', ], [ 'errorCode' => 'ARMNotSupport', 'errorMessage' => 'ARM arch does not support this operation.', ], [ 'errorCode' => 'HostTypeNotSupport', 'errorMessage' => 'Host type is inconsistent, please check that the original host type is the same as the target host type.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'MaxscaleInstanceNotSupport', 'errorMessage' => 'Instances with maxscale instance do not support this operation.', ], [ 'errorCode' => 'ReadInstanceNotSupport', 'errorMessage' => 'Instances with read-only do not support this operation.', ], [ 'errorCode' => 'UnSupportReduceDiskSize', 'errorMessage' => 'Current instance type does not support reducing disk space.', ], [ 'errorCode' => 'CloudboxInstanceNotSupport', 'errorMessage' => 'Cloud-box instance does not support this operation.', ], [ 'errorCode' => 'ReadOnlyInstanceNotSupport', 'errorMessage' => 'Read-only instance does not support this operation.', ], [ 'errorCode' => 'MinorVersionNotSupport', 'errorMessage' => 'The current database minor version does not support the operation.', ], [ 'errorCode' => 'ShrinkCountReachedLimit', 'errorMessage' => 'Current DB shrink count reached the limit.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudDiskEncryptionNotSupport', 'errorMessage' => 'The encryption key is not allowed for general-purpose instance.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], [ 'errorCode' => 'UnsupportedByBlueGreenDeployment', 'errorMessage' => 'Operation prohibited due to blue green deployment.', ], [ 'errorCode' => 'UnSupportNonXfsDiskSizeTooLarge', 'errorMessage' => 'Non xfs disk types do not support upgrading to 60T or above.', ], [ 'errorCode' => 'OperationDenied.SystemConcurrent', 'errorMessage' => 'Failure caused by Concurrent operations.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'The parameter is invalid.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'CallLxSdkFailed', 'errorMessage' => 'Error calling the order system, please try again later or contact service personnel.', ], [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBInstanceId\\": \\"rm-uf6wjk5****\\",\\n \\"OrderId\\": 0,\\n \\"RequestId\\": \\"3C5CFDEE-F774-4DED-89A2-1D76EC63C575\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 3C5CFDEE-F774-4DED-89A2-1D76EC63C575\\n rm-uf6wjk5*******\\n 20793850608****\\n","errorExample":""}]', 'title' => 'ModifyDBInstanceSpec', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" .'* MariaDB'."\n" ."\n" .'### [](#)Billing details'."\n" ."\n" .'[Fees for specification changes](~~57178~~) are generated if the call is successful. Before you call this operation, carefully read the following topics.'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'* [Change the specifications of an ApsaraDB RDS for MySQL instance](~~96061~~)'."\n" .'* [Change the specifications of an ApsaraDB RDS for PostgreSQL instance](~~96750~~)'."\n" .'* [Change the specifications of an ApsaraDB RDS for SQL Server instance](~~95665~~)'."\n" .'* [Change the specifications of an ApsaraDB RDS for MariaDB instance](~~97129~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DestroyDBInstance' => [ 'summary' => 'You can call the DestroyDBInstance operation to destroy an instance. The instance is in the Locked state.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request.'."\n" ."\n" .'> You can use the client to generate the value, but you must ensure that it is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCziJZNwH****', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the instance. You can call the [DescribeDBInstances](~~26232~~) operation to query the ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5xxxxxxxxxx', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '65BDA532-28AF-4122-AA39-B382721EEE64', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'OperationDenied.DBInstanceStatus', 'errorMessage' => 'The operation is not permitted due to status of instance.', ], [ 'errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', ], [ 'errorCode' => 'OperationDenied.DBInstance', 'errorMessage' => 'The operation is not permitted due to status of the instance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The specified instance is not found.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'MasterInstanceNotExist', 'errorMessage' => 'master instance not exist.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceName.Deleted', 'errorMessage' => 'The specified DB instance is deleted.', ], [ 'errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance does not exist or is not supported.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"65BDA532-28AF-4122-AA39-B382721EEE64\\"\\n}","errorExample":""},{"type":"xml","example":"\\n\\n\\t 65BDA532-28AF-4122-AA39-B382721EEE64\\n\\t\\n","errorExample":""}]', 'title' => 'DestroyDBInstance', 'description' => 'The DestroyDBInstance operation is phased out.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ModifyDasInstanceConfig' => [ 'summary' => 'Configures automatic storage expansion for an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'paid', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the generated token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCz*****', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5*****', ], ], [ 'name' => 'StorageAutoScale', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable automatic storage expansion. Valid values:'."\n" ."\n" .'* **Enable**'."\n" .'* **Disable**'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'enumValueTitles' => [], 'example' => 'Enable', 'enum' => [ 'Enable', 'Disable', ], ], ], [ 'name' => 'StorageThreshold', 'in' => 'query', 'schema' => [ 'description' => 'The threshold in percentage based on which an automatic storage expansion is triggered. If the available storage reaches the threshold, ApsaraDB RDS increases the storage capacity of the instance. Valid values:'."\n" ."\n" .'* **10**'."\n" .'* **20**'."\n" .'* **30**'."\n" .'* **40**'."\n" .'* **50**'."\n" ."\n" .'> If you set the StorageAutoScale parameter to **Enable**, you must specify this parameter.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '50', 'minimum' => '10', 'enumValueTitles' => [], 'example' => '50', 'default' => '10', 'enum' => [ '10', '20', '30', '40', '50', ], ], ], [ 'name' => 'StorageUpperBound', 'in' => 'query', 'schema' => [ 'description' => 'The maximum storage capacity that is allowed for an automatic storage expansion. The value of this parameter must be greater than or equal to the current storage capacity of the RDS instance.'."\n" ."\n" .'* If the RDS instance uses ESSDs, the maximum value of this parameter can be set to 32000 GB.'."\n" .'* If the RDS instance uses standard SSDs, the maximum value of this parameter can be set to 6000 GB.'."\n" ."\n" .'> If you set the **StorageAutoScale** parameter to **Enable**, you must specify this parameter.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '0', 'example' => '1000', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'C3C247D4-1643-4C5D-87C2-C829543FC626', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'AccessHDMInstanceFailed', 'errorMessage' => 'The specified instance access HDM failed.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'InvalidStorageType.NotSupport', 'errorMessage' => 'The current storage type does not support this operation.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C3C247D4-1643-4C5D-87C2-C829543FC626\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\nC3C247D4-1643-4C5D-87C2-C829543FC626\\r\\n","errorExample":""}]', 'title' => 'ModifyDasInstanceConfig', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.'."\n" ."\n" .'* [Configure automatic storage expansion for ApsaraDB RDS for MySQL](~~173826~~)'."\n" .'* [Configure automatic storage expansion for ApsaraDB RDS for PostgreSQL](~~432496~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'MigrateToOtherZone' => [ 'summary' => 'Migrates an instance across zones in the same region.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5xxxxxxxxxx', ], ], [ 'name' => 'VPCId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the virtual private cloud (VPC). Do not change the VPC of the instance when you migrate the instance across zones.'."\n" ."\n" .'* This parameter must be specified when the instance resides in a VPC.'."\n" .'* If the instance runs SQL Server, you can change the VPC of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vpc-xxxxxxx', ], ], [ 'name' => 'ZoneId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the destination zone. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou-b', ], ], [ 'name' => 'EffectiveTime', 'in' => 'query', 'schema' => [ 'description' => 'The time when you want the change to take effect. Valid values:'."\n" ."\n" .'* **Immediately** (default): The change immediately takes effect.'."\n" .'* **MaintainTime**: The change takes effect during the maintenance window. For more information, see ModifyDBInstanceMaintainTime.'."\n" .'* **ScheduleTime**: The change takes effect at the point in time that you specify.'."\n" ."\n" .'> If you set this parameter to **ScheduleTime**, you must specify the **SwitchTime** parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Immediate', ], ], [ 'name' => 'VSwitchId', 'in' => 'query', 'schema' => [ 'description' => 'The vSwitch ID.'."\n" ."\n" .'* This parameter must be specified when the instance resides in a VPC. You can call the DescribeVSwitches operation to query existing vSwitches.'."\n" .'* If the instance runs PostgreSQL or SQL Server and a secondary zone is specified for the instance, you can specify multiple vSwitch IDs, each of which corresponds to a zone. Separate the vSwitch IDs with commas (,).'."\n", 'type' => 'string', 'required' => false, 'example' => 'vsw-uf6adz52c2pxxxxxxx', ], ], [ 'name' => 'Category', 'in' => 'query', 'schema' => [ 'description' => 'The RDS edition of the instance. Valid values:'."\n" ."\n" .'* **Basic**: RDS Basic Edition'."\n" .'* **HighAvailability**: RDS High-availability Edition'."\n" .'* **AlwaysOn**: SQL Server on RDS Cluster Edition'."\n" .'* **cluster**: MySQL on RDS Cluster Edition'."\n" .'* **Finance**: RDS Enterprise Edition'."\n", 'type' => 'string', 'required' => false, 'example' => 'HighAvailability', ], ], [ 'name' => 'ZoneIdSlave1', 'in' => 'query', 'schema' => [ 'description' => 'The secondary zone 1 of the instance.'."\n" ."\n" .'> This parameter must be configured if the instance runs RDS editions other than RDS Basic Edition.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-c', ], ], [ 'name' => 'ZoneIdSlave2', 'in' => 'query', 'schema' => [ 'description' => 'The secondary zone 2 of the instance.'."\n" ."\n" .'> You can specify this parameter only for instances that run RDS Enterprise Edition.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-d', ], ], [ 'name' => 'SwitchTime', 'in' => 'query', 'schema' => [ 'description' => 'The migration time. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time must be in UTC.'."\n" ."\n" .'> This parameter is used with **EffectiveTime**. You must specify this parameter only when **EffectiveTime** is set to **ScheduleTime**.'."\n", 'type' => 'string', 'required' => false, 'example' => '2021-12-14T15:15:15Z', ], ], [ 'name' => 'IsModifySpec', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to change the specifications of the instance during the cross-zone migration. Valid values:'."\n" ."\n" .'* **true**: You want to change the specifications of the instance during the cross-zone migration. If you set this parameter to **true**, you must specify at least one of **DBInstanceClass** and **DBInstanceStorage**.'."\n" .'* **false** (default): You do not want to change the specifications of the instance during the cross-zone migration.'."\n" ."\n" .'> This parameter applies only to instances that run MySQL.'."\n", 'type' => 'string', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'DBInstanceClass', 'in' => 'query', 'schema' => [ 'description' => 'The new instance type of the instance. You can change the instance type of the instance. You cannot change the storage type of the instance. If you set **IsModifySpec** to **true**, you must specify at least one of DBInstanceClass and **DBInstanceStorage**.'."\n" ."\n" .'For more information about instance types, see [Primary ApsaraDB RDS for MySQL instance types](~~276975~~).'."\n", 'type' => 'string', 'required' => false, 'example' => 'mysql.x4.xlarge.2', ], ], [ 'name' => 'DBInstanceStorage', 'in' => 'query', 'schema' => [ 'description' => 'The new storage capacity of the instance. If you set **IsModifySpec** to **true**, you must specify at least one of DBInstanceStorage and **DBInstanceClass**.'."\n" ."\n" .'Unit: GB. The available storage capacity range varies based on the instance type of the instance. For more information, see [Primary ApsaraDB RDS for MySQL instance types](~~276975~~).'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '500', ], ], [ 'name' => 'IoAccelerationEnabled', 'in' => 'query', 'schema' => [ 'description' => 'A reserved parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => '0', ], ], [ 'name' => 'DBInstanceStorageType', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, 'description' => 'The storage type of the instance. Valid values:'."\n" ."\n" .'* **local_ssd**: local SSD. This is the recommended storage type.'."\n" .'* **general_essd**: general Enterprise SSD (ESSD). This is the recommended storage type.'."\n" .'* **cloud_essd**: PL1 ESSD'."\n" .'* **cloud_essd2**: PL2 ESSD'."\n" .'* **cloud_essd3**: PL3 ESSD'."\n" .'* **cloud_ssd**: standard SSD. This storage type is not recommended. Standard SSDs are no longer available for purchase in some Alibaba Cloud regions.'."\n" ."\n" .'The default value of this parameter is determined by the instance type specified by the **DBInstanceClass** parameter.'."\n" ."\n" .'* If the instance type specifies the local SSD storage type, the default value of this parameter is **local_ssd**.'."\n" .'* If the instance type specifies the standard SSD or ESSD storage type, the default value of this parameter is **cloud_essd**.'."\n" ."\n" .'> Serverless instances support only PL1 ESSDs and general ESSDs.'."\n", 'example' => 'local_ssd', ], ], [ 'name' => 'CustomExtraInfo', 'in' => 'query', 'schema' => [ 'type' => 'string', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'DBInstanceId' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5xxxxxxxxxx', ], 'OrderId' => [ 'description' => 'The ID of the order. This parameter is returned only when the instance runs MySQL.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '213341575990728', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '65BDA532-28AF-4122-AA39-B382721EEE64', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'RenewChange.Exist', 'errorMessage' => 'The Current InstanceId existed renewChange order in RDS.', ], [ 'errorCode' => 'InvalidInstanceCommodityCode.NotFound', 'errorMessage' => 'Parse commodityCode from lx and instance fail.', ], [ 'errorCode' => 'InvalidMigrateModifyClassOrStorage', 'errorMessage' => 'Specified parameter DBInstanceClass or Storage is invalid.', ], [ 'errorCode' => 'EngineNotSupported', 'errorMessage' => 'Engine specified cannot be supported the operation.', ], [ 'errorCode' => 'IncorrectDBInstanceLockMode.ValueNotSupported', 'errorMessage' => 'The Current DB instance lock mode does not support this operation.', ], [ 'errorCode' => 'InvalidZoneId.NotNull', 'errorMessage' => 'The parameter ZoneId must not be null or auto', ], [ 'errorCode' => 'InvalidZoneId.NotEqual', 'errorMessage' => 'The parameter ZoneId is the same as the previous one', ], [ 'errorCode' => 'InvalidDispenseMode.Format', 'errorMessage' => 'The specified dispense mode is not valid.', ], [ 'errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', ], [ 'errorCode' => 'ZoneId.NotMatchWithCategory', 'errorMessage' => 'The Number of ZoneId specified does not match with category', ], [ 'errorCode' => 'InvalidDefaultVSwitch.NotFound', 'errorMessage' => 'The specified default virtual switch is not found in specified VPC.', ], [ 'errorCode' => 'InsufficientResourceCapacityCheck', 'errorMessage' => 'There is insufficient capacity available for the requested instance with precheck.', ], [ 'errorCode' => 'UnsupportedReadOrBakReadState', 'errorMessage' => 'Current DB instance has read or bak read instance running in unsupported states', ], [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'SSLInstanceNotSupportThisOperation', 'errorMessage' => 'The instance opened SSL, upgrade is not this operation', ], [ 'errorCode' => 'BYOLInstanceNotSupportThisOperation', 'errorMessage' => 'The BYOL instance is not supported this operation', ], [ 'errorCode' => 'BYOKInstanceNotSupportThisOperation', 'errorMessage' => 'The BYOK instance is not supported this operation', ], [ 'errorCode' => 'ADInstanceNotSupportThisOperation', 'errorMessage' => 'The AD instance is not supported this operation', ], [ 'errorCode' => 'TDEInstanceNotSupportThisOperation', 'errorMessage' => 'The instance opened TDE, this operation is not supported', ], [ 'errorCode' => 'InstanceIsSnapshotBackupNotSupportThisOperation', 'errorMessage' => 'The instance backup method is snapshot backup, this operation is not supported', ], [ 'errorCode' => 'InstanceHasReadOnlyInstanceNotSupportThisOperation', 'errorMessage' => 'The instance has read-only instance or is read-only instance, this operation is not supported', ], [ 'errorCode' => 'VswitchIpExhausted', 'errorMessage' => 'No available ip in the specified vswitch.', ], [ 'errorCode' => 'OperationDenied.MasterDBInstanceState', 'errorMessage' => 'The operation is not permitted due to status of master instance.', ], [ 'errorCode' => 'InvalidShareInstance.NotSupport', 'errorMessage' => 'The share dbInstance is not support.', ], [ 'errorCode' => 'InvalidZoneIdSlave1.Missing', 'errorMessage' => 'The parameter ZoneIdSlave1 must be specified.', ], [ 'errorCode' => 'MigrateAlreadyExistsFault', 'errorMessage' => 'The rds instance already has a given vpc migrate task.', ], [ 'errorCode' => 'InvalidInstanceKind.NotSupport', 'errorMessage' => 'The instance kind does not support this operation.', ], [ 'errorCode' => 'MissingCategory', 'errorMessage' => 'The instance is missing a category parameter.', ], [ 'errorCode' => 'InvalidInstanceNodeType.NotFound', 'errorMessage' => 'The specified NodeType is not found.', ], [ 'errorCode' => 'EngineVersionNotSupported', 'errorMessage' => 'EngineVersion specified cannot be replicate with the source DB Instance.', ], [ 'errorCode' => 'CommodityCodeNotFound', 'errorMessage' => 'CommodityCodeNotFound', ], [ 'errorCode' => 'InvalidTunnelId', 'errorMessage' => 'Specified conn tunnel is not valid.', ], [ 'errorCode' => 'SSLNotSupport', 'errorMessage' => 'The CharacterType of instance does not support SSL.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'UnSupportDbTypeReduceDiskSize', 'errorMessage' => 'The current instance does not support scale-in.', ], [ 'errorCode' => 'UnsupportedReduceDiskSize', 'errorMessage' => 'Current Instance not support reduce disk size less than limit size.', ], [ 'errorCode' => 'UnsupportExtendDisk.NotSupport', 'errorMessage' => 'Specified DB instance is unsupport extend disk.', ], [ 'errorCode' => 'ClassicNetDisabled', 'errorMessage' => 'The classic network address is currently disabled, and the instance cannot perform configuration changes.', ], [ 'errorCode' => 'InvalidParamForXfs', 'errorMessage' => 'Xfs instance must be single tenant standard instance.', ], ], 403 => [ [ 'errorCode' => 'OperationDenied.OutofUsage', 'errorMessage' => 'The resource is out of usage.', ], [ 'errorCode' => 'IncorrectEffectiveTime', 'errorMessage' => 'The specified EffectiveTime params is not valid.', ], [ 'errorCode' => 'InvalidTempInstance.NotSupport', 'errorMessage' => 'The temp db Instance is not support.', ], [ 'errorCode' => 'OperationDenied.LockMode', 'errorMessage' => 'The operation is not permitted due to instance being locked.', ], [ 'errorCode' => 'ClassicNetworkType.NotSupport', 'errorMessage' => 'The Classic instance network create is not support.', ], [ 'errorCode' => 'InstanceNetworkTypeNotFoundFault', 'errorMessage' => 'The specified DBInstanceNetworkType is not found.', ], [ 'errorCode' => 'ProprietaryCloud.NotSupported', 'errorMessage' => 'The proprietary cloud not supported.', ], [ 'errorCode' => 'MigrateAlreadyReadWriteSplitExistsFault', 'errorMessage' => 'The rds instance already has a given vpc migrate task.', ], [ 'errorCode' => 'InvalidRegionAvzNotFound', 'errorMessage' => 'Specified user does not find the region and avz.', ], [ 'errorCode' => 'ZoneIdNotSupported', 'errorMessage' => 'The zone ID is not supported.', ], [ 'errorCode' => 'InvalidVpcInfo.NotFound', 'errorMessage' => 'Specified VPC info does not exist.', ], [ 'errorCode' => 'InvalidMultiparamZoneInfoList', 'errorMessage' => 'Zoneinfo list is invaild.', ], [ 'errorCode' => 'MigrateSlaveNotSupport', 'errorMessage' => 'Current DB instance state does not support migrating slave, please switch the Primary/Secondary Instance first.', ], [ 'errorCode' => 'CloudDiskEncryptionNotSupport', 'errorMessage' => 'The encryption key is not allowed for general-purpose instance.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], [ 'errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', ], [ 'errorCode' => 'UnsupportedByBlueGreenDeployment', 'errorMessage' => 'Operation prohibited due to blue green deployment.', ], [ 'errorCode' => 'CurrentRecoveryModelNotSupportThisAction', 'errorMessage' => 'Current recovery model not supported this action.', ], [ 'errorCode' => 'UnSupportNonXfsDiskSizeTooLarge', 'errorMessage' => 'Non xfs disk types do not support upgrading to 60T or above.', ], [ 'errorCode' => 'ShrinkCountReachedLimit', 'errorMessage' => 'Current DB shrink count reached the limit.', ], [ 'errorCode' => 'IncorrectReadDBInstanceDisksize', 'errorMessage' => 'Read instance disk size must be equal or higher than primary instance.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', ], [ 'errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DBInstanceId\\": \\"rm-uf6wjk5****\\",\\n \\"OrderId\\": 0,\\n \\"RequestId\\": \\"65BDA532-28AF-4122-AA39-B382721EEE64\\"\\n}","type":"json"}]', 'title' => 'MigrateToOtherZone', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* RDS MySQL'."\n" .'* RDS PostgreSQL'."\n" .'* RDS SQL Server'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> : Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.'."\n" ."\n" .'* [Migrate an ApsaraDB RDS for MySQL instance across zones in the same region](~~96053~~)'."\n" .'* [Migrate an ApsaraDB RDS for PostgreSQL instance across zones in the same region](~~96746~~)'."\n" .'* [Migrate an ApsaraDB RDS for SQL Server instance across zones in the same region](~~95658~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ModifyDBInstanceDescription' => [ 'summary' => 'You can call the ModifyDBInstanceDescription operation to modify the name of an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5****', ], ], [ 'name' => 'DBInstanceDescription', 'in' => 'query', 'schema' => [ 'description' => 'The name of the instance.'."\n" ."\n" .'> The name must be 2 to 64 characters in length.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Instance in Alibaba Cloud test environment', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '17F57FEE-EA4F-4337-8D2E-9C23CAA63D74', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidDBInstanceDescription.Format', 'errorMessage' => 'Specified DB instance description is not valid.', ], [ 'errorCode' => 'InvalidDBDescription.Format', 'errorMessage' => 'Specified DB description is not valid.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"17F57FEE-EA4F-4337-8D2E-9C23CAA63D74\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\" 17F57FEE-EA4F-4337-8D2E-9C23CAA63D74\\"\\n}"},{"type":"xml","example":"\\n 17F57FEE-EA4F-4337-8D2E-9C23CAA63D74\\n","errorExample":"< ModifyDBInstanceDescriptionResponse>\\n 17F57FEE-EA4F-4337-8D2E-9C23CAA63D74\\n"}]', 'title' => 'Modify the name of an instance', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ModifyDBInstanceMaintainTime' => [ 'summary' => 'Modifies the maintenance window of an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxxxxx', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-uf6wjk5xxxxxxx', ], ], [ 'name' => 'MaintainTime', 'in' => 'query', 'schema' => [ 'description' => 'The maintenance window of the instance. Specify the time in the *HH:mm*Z-*HH:mm*Z format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => true, 'example' => '22:00Z-02:00Z', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '65BDA532-28AF-4122-AA39-B382721EEE64', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidMaintainTime', 'errorMessage' => 'The MaintainTime parameter is invalid.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"65BDA532-28AF-4122-AA39-B382721EEE64\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"7463B73D-35CC-4D19-A010-6B8D65D242EF\\",\\n \\"HostId\\": \\"rds.aliyuncs.com\\",\\n \\"Code\\": \\"UnsupportedOperation\\",\\n \\"Message\\": \\"The specified action is not supported.\\"\\n}"},{"type":"xml","example":"\\n 65BDA532-28AF-4122-AA39-B382721EEE64\\n","errorExample":""}]', 'title' => 'ModifyDBInstanceMaintainTime', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" .'* MariaDB'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> Before you call this operation, read the following documentation and make sure that you fully understand the prerequisites and impacts of this operation.'."\n" ."\n" .'* [Set a maintenance window for an ApsaraDB RDS for MySQL instance](~~96052~~)'."\n" .'* [Set a maintenance window for an ApsaraDB RDS for PostgreSQL instance](~~96799~~)'."\n" .'* [Set a maintenance window for an ApsaraDB RDS for SQL Server instance](~~95657~~)'."\n" .'* [Set a maintenance window for an ApsaraDB RDS for MariaDB instance](~~97473~~)', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ModifyResourceGroup' => [ 'summary' => 'Moves an ApsaraDB RDS instance to a specified resource group.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCzxxxxxx', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-bpxxxxx', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The resource group ID. You can call the ListResourceGroups operation to obtain the resource group ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rg-acxxxxx', ], ], [ 'name' => 'ResourceType', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, 'example' => 'Instance', 'enum' => [], 'description' => 'The resource type.'."\n", ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '65BDA532-28AF-4122-AA39-B382721EEE64', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'ResourceGroupId.InValid', 'errorMessage' => 'The Specified resource group id is not found.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"65BDA532-28AF-4122-AA39-B382721EEE64\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n65BDA532-28AF-4122-AA39-B382721EEE64\\r\\n","errorExample":""}]', 'title' => 'ModifyResourceGroup', 'description' => '### Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" .'* MariaDB'."\n" ."\n" .'### References'."\n" ."\n" .'> Before you call this operation, read the following documentation and make sure that you fully understand the prerequisites and impacts of this operation.'."\n" ."\n" .'[Transfer resources across resource groups](~~94487~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ModifyHADiagnoseConfig' => [ 'summary' => 'Change the availability check method of an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5xxxxxxxxxx', ], ], [ 'name' => 'TcpConnectionType', 'in' => 'query', 'schema' => [ 'description' => 'The availability check method of the instance. Valid values:'."\n" ."\n" .'* **SHORT**: Alibaba Cloud uses short-lived connections to check the availability of the instance.'."\n" .'* **LONG**: Alibaba Cloud uses persistent connections to check the availability of the instance.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'SHORT', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '9EFA6DF3-5247-4D9D-80AA-68765BE6D5EA', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'HaDiagnoseConfig.Format', 'errorMessage' => 'The value of tcpConnectionType must be LONG or SHORT', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9EFA6DF3-5247-4D9D-80AA-68765BE6D5EA\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 9EFA6DF3-5247-4D9D-80AA-68765BE6D5EA\\r\\n","errorExample":""}]', 'title' => 'ModifyHADiagnoseConfig', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" .'* MariaDB'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> Before you call this operation, read the following documentation and make sure that you fully understand the prerequisites and impacts of this operation.'."\n" ."\n" .'[What is availability check?](~~207467~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ModifyAccountSecurityPolicy' => [ 'summary' => 'Modifies the password policy for an account of an ApsaraDB RDS for SQL Server instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCz****', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy****', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the [DescribeDBInstances](~~2628785~~) operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-bp1ibu****', ], ], [ 'name' => 'GroupPolicy', 'in' => 'query', 'schema' => [ 'description' => 'The custom password policy for the account of the ApsaraDB RDS for SQL Server instance. The following policies are supported:'."\n" ."\n" .'* `{"account security policy": {"MaximumPasswordAge": Specify the maximum password age}}`: You can configure only the maximum password age. After the maximum password age is reached, you must change the password.'."\n" .'* `{"accountSecurityPolicy": {"MaximumPasswordAge": Specify the minimum password age}}`: You can configure only the minimum password age. During the specified period, you cannot change the password.'."\n" .'* `{"accountSecurityPolicy": {"MaximumPasswordAge": Specify the maximum password age, "MinimumPasswordAge": Specify the minimum password age}}`: You can configure the maximum and minimum password age at the same time.'."\n" ."\n" .'> The minimum password age cannot be greater than the maximum password age. Valid values for the minimum password age: 0 to 998. Valid values for the maximum password age: 0 to 999.'."\n", 'type' => 'string', 'required' => true, 'example' => '{"accountSecurityPolicy": {"MaximumPasswordAge": 30, "MinimumPasswordAge": 20}}', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'F2911788-25E8-42E5-A3A3-1B38D263F01E', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'GroupPolicyNotFound', 'errorMessage' => 'The specified group policy does not exist.', ], [ 'errorCode' => 'InvalidGroupPolicyValue', 'errorMessage' => 'The value of the group policy is invalid.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2911788-25E8-42E5-A3A3-1B38D263F01E\\"\\n}","type":"json"}]', 'title' => 'ModifyAccountSecurityPolicy', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'SQL Server (This parameter is unavailable for ApsaraDB RDS for SQL Server instances that belong to the shared instance family and run SQL Server 2008 R2.)'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> Before you call this operation, read the following topics and make sure that you fully understand the prerequisites and impacts of this operation.'."\n" ."\n" .'[Create a custom password policy for an account of an ApsaraDB RDS for SQL Server instance](~~95640~~)'."\n", ], 'DescribeSupportOnlineResizeDisk' => [ 'summary' => 'Checks whether the disk of an ApsaraDB RDS for SQL Server instance can be resized online.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-uf6wjk5xxxxxxx', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Code' => [ 'description' => 'The response code returned.'."\n", 'type' => 'string', 'example' => 'NotExists.InstanceId', ], 'Data' => [ 'description' => 'The response result set.'."\n", 'type' => 'string', 'example' => '{"SupportOnlineResizeDisk":true,"DBInstanceName":"rm-uf6wjk5xxxxxxx"}', ], 'Message' => [ 'description' => 'The response code.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '8B993DA9-5272-5414-94E3-4CA8BA0146C2', ], 'Success' => [ 'description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Data\\": \\"{\\\\n \\\\\\"SupportOnlineResizeDisk\\\\\\": true,\\\\n \\\\\\"DBInstanceName\\\\\\": \\\\\\"rm-bp****\\\\\\",\\\\n \\\\\\"maxSupportDiskSizeGB\\\\\\": 6144\\\\n}\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"8B993DA9-5272-5414-94E3-4CA8BA0146C2\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'DescribeSupportOnlineResizeDisk', 'description' => '### Supported database engine'."\n" ."\n" .'SQL Server'."\n", ], 'DescribeAvailableZones' => [ 'summary' => 'Queries the available zones for an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'Engine', 'in' => 'query', 'schema' => [ 'description' => 'The database engine of the instance. Valid values:'."\n" ."\n" .'* **MySQL**'."\n" .'* **SQLServer**'."\n" .'* **PostgreSQL**'."\n" .'* **MariaDB**'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MySQL', ], ], [ 'name' => 'ZoneId', 'in' => 'query', 'schema' => [ 'description' => 'The zone ID. If the instance spans more than one zone, the value of this parameter contains an `MAZ` part, such as `cn-hangzhou-MAZ6(b,f)` and `cn-hangzhou-MAZ5(b,e,f)`. You can call the DescribeRegions operation to query the most recent zone list.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-e', ], ], [ 'name' => 'EngineVersion', 'in' => 'query', 'schema' => [ 'description' => 'The database engine version. Valid values:'."\n" ."\n" .'* Regular instance'."\n" ."\n" .' * Valid values if you set Engine to MySQL: **5.5**, **5.6**, **5.7**, and **8.0**'."\n" .' * Valid values if you set Engine to SQLServer: **2008r2**, **08r2\\_ent_ha**, **2012**, **2012\\_ent_ha**, **2012\\_std_ha**, **2012\\_web**, **2014\\_std_ha**, **2016\\_ent_ha**, **2016\\_std_ha**, **2016\\_web**, **2017\\_std_ha**, **2017\\_ent**, **2019\\_std_ha**, and **2019\\_ent**'."\n" .' * Valid values if you set Engine to PostgreSQL: **10.0**, **11.0**, **12.0**, **13.0**, **14.0**, and **15.0**'."\n" .' * Valid value when you set Engine to MariaDB: **10.3**'."\n" ."\n" .'* Serverless instance'."\n" ."\n" .' * Valid values if you set Engine to MySQL: **5.7** and **8.0**'."\n" .' * Valid values if you set Engine to SQLServer: **2016\\_std_sl**, **2017\\_std_sl**, and **2019\\_std_sl**'."\n" .' * Valid value if you set Engine to PostgreSQL: **14.0**'."\n" ."\n" .' **'."\n" ."\n" .' **Note**ApsaraDB RDS for MariaDB does not support serverless instances.'."\n", 'type' => 'string', 'required' => false, 'example' => '8.0', ], ], [ 'name' => 'CommodityCode', 'in' => 'query', 'schema' => [ 'description' => 'The commodity code of the instance. This operation can return the resources that you can purchase based on the specified commodity code. Valid values:'."\n" ."\n" .'* **bards**: The instance is a pay-as-you-go primary instance. This value is available at the China site (aliyun.com).'."\n" .'* **rds**: The instance is a subscription primary instance. This value is available at the China site (aliyun.com).'."\n" .'* **rords**: The instance is a pay-as-you-go read-only instance. This value is available at the China site (aliyun.com).'."\n" .'* **rds_rordspre_public_cn**: The instance is a subscription read-only instance. This value is available at the China site (aliyun.com).'."\n" .'* **bards_intl**: The instance is a pay-as-you-go primary instance. This value is available at the International site (alibabacloud.com).'."\n" .'* **rds_intl**: The instance is a subscription primary instance. This value is available at the International site (alibabacloud.com).'."\n" .'* **rords_intl**: The instance is a pay-as-you-go read-only instance. This value is available at the International site (alibabacloud.com).'."\n" .'* **rds_rordspre_public_intl**: The instance is a subscription read-only instance. This value is available at the International site (alibabacloud.com).'."\n" .'* **rds_serverless_public_cn**: The instance is a serverless instance. This value is available at the China site (aliyun.com).'."\n" .'* **rds_serverless_public_intl**: The instance is a serverless instance. This value is available at the International site (alibabacloud.com).'."\n", 'type' => 'string', 'required' => false, 'example' => 'bards', ], ], [ 'name' => 'DispenseMode', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to return the zones in which the single-zone deployment method is supported. Valid values:'."\n" ."\n" .'* **1** (default): returns the zones.'."\n" .'* **0**: does not return the zones.'."\n" ."\n" .'> The single-zone deployment method allows you to deploy an instance that runs RDS Enterprise Edition in a single zone.'."\n", 'type' => 'string', 'required' => false, 'example' => '0', ], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the primary instance. If you want to query the read-only instances that you can purchase for a primary instance, you can specify this parameter.'."\n" ."\n" .'If you set **CommodityCode** to one of the following values, you must specify this parameter:'."\n" ."\n" .'* **rords_intl**'."\n" .'* **rds_rordspre_public_intl**'."\n" .'* **rords**'."\n" .'* **rds_rordspre_public_cn**'."\n", 'type' => 'string', 'required' => false, 'example' => 'rm-uf6wjk5xxxxxxx', ], ], [ 'name' => 'Category', 'in' => 'query', 'schema' => [ 'description' => 'The RDS edition of the instance. Valid values:'."\n" ."\n" .'* Regular instance'."\n" ."\n" .' * **Basic**: RDS Basic Edition.'."\n" .' * **HighAvailability**: RDS High-availability Edition.'."\n" .' * **cluster**: RDS Cluster Edition for ApsaraDB RDS for MySQL.'."\n" .' * **AlwaysOn**: RDS Cluster Edition for ApsaraDB RDS for SQL Server.'."\n" .' * **Finance**: RDS Enterprise Edition.'."\n" ."\n" .'* Serverless instance'."\n" ."\n" .' * **serverless_basic**: RDS Basic Edition. This edition is available only for instances that run MySQL and PostgreSQL.'."\n" .' * **serverless_standard**: RDS High-availability Edition for ApsaraDB RDS for MySQL.'."\n" .' * **serverless_ha**: RDS High-availability Edition for ApsaraDB RDS for SQL Server.'."\n", 'type' => 'string', 'required' => false, 'example' => 'HighAvailability', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'AvailableZones' => [ 'description' => 'The available zones in the region.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'RegionId' => [ 'description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], 'SupportedEngines' => [ 'description' => 'The database engines that are available for purchase.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Engine' => [ 'description' => 'The database engine of the instance.'."\n", 'type' => 'string', 'example' => 'MySQL', ], 'SupportedEngineVersions' => [ 'description' => 'The database engine versions that are available for purchase.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'SupportedCategorys' => [ 'description' => 'The RDS editions that are available that are available for purchase.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Category' => [ 'description' => 'The RDS edition of the instance.'."\n", 'type' => 'string', 'example' => 'HighAvailability', ], 'SupportedStorageTypes' => [ 'description' => 'The storage types that are available for purchase.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'StorageType' => [ 'description' => 'The storage type of the instance.'."\n", 'type' => 'string', 'example' => 'local_ssd', ], ], ], ], ], ], ], 'Version' => [ 'description' => 'The database engine version.'."\n", 'type' => 'string', 'example' => '8.0', ], ], ], ], ], ], ], 'ZoneId' => [ 'description' => 'The zone ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou-e', ], ], ], ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '4256E149-C3C4-4FA7-BDEA-13CA415E8763', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'ArticleNotFound', 'errorMessage' => 'Article not found', ], [ 'errorCode' => 'InvalidDBInstanceName', 'errorMessage' => 'The specified parameter DBInstanceName is null or the instance cannot be found, please check parameter DBInstanceName.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'DBInstanceName not found', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"AvailableZones\\": [\\n {\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"SupportedEngines\\": [\\n {\\n \\"Engine\\": \\"MySQL\\",\\n \\"SupportedEngineVersions\\": [\\n {\\n \\"SupportedCategorys\\": [\\n {\\n \\"Category\\": \\"HighAvailability\\",\\n \\"SupportedStorageTypes\\": [\\n {\\n \\"StorageType\\": \\"local_ssd\\"\\n }\\n ]\\n }\\n ],\\n \\"Version\\": \\"8.0\\"\\n }\\n ]\\n }\\n ],\\n \\"ZoneId\\": \\"cn-hangzhou-e\\"\\n }\\n ],\\n \\"RequestId\\": \\"4256E149-C3C4-4FA7-BDEA-13CA415E8763\\"\\n}","errorExample":""},{"type":"xml","example":"\\n4256E149-C3C4-4FA7-BDEA-13CA415E8763\\n\\n cn-hangzhou-e\\n cn-hangzhou\\n \\n \\n 8.0\\n \\n HighAvailability\\n \\n local_ssd\\n \\n \\n cloud_ssd\\n \\n \\n \\n Basic\\n \\n cloud_ssd\\n \\n \\n \\n MySQL\\n \\n\\n","errorExample":""}]', 'title' => 'DescribeAvailableZones', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* RDS MySQL'."\n" .'* RDS PostgreSQL'."\n" .'* RDS SQL Server'."\n" .'* RDS MariaDB'."\n" ."\n" .'> You can call this operation to query the available zones for an instance. The query result may be different from the zones available on the buy page of the ApsaraDB RDS console. The values of some parameters on the buy page vary based on the actual sales policy. The actual information on the [buy page](https://rdsbuy.console.aliyun.com/create/rds/PostgreSQL) prevails.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeAvailableClasses' => [ 'summary' => 'Queries the specifications that are supported for an instance. The specifications include the instance type and the storage capacity.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the instance. You can call the DescribeDBInstanceAttribute operation to query the region ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'ZoneId', 'in' => 'query', 'schema' => [ 'description' => 'The zone ID of the instance. You can call the DescribeDBInstanceAttribute operation to query the zone ID of the instance.'."\n" ."\n" .'> If the DescribeDBInstanceAttribute operation returns multiple zones, you must specify only one of the returned zones. For example, if the DescribeDBInstanceAttribute operation returns `cn-hangzhou-MAZ9(g,h)`, you can set this parameter to `cn-hangzhou-g` or `cn-hangzhou-h`.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou-h', ], ], [ 'name' => 'InstanceChargeType', 'in' => 'query', 'schema' => [ 'description' => 'The billing method of the instance. Valid values:'."\n" ."\n" .'* **Prepaid**: subscription'."\n" .'* **Postpaid**: pay-as-you-go'."\n" .'* **Serverless**: serverless'."\n" ."\n" .'> ApsaraDB RDS for MariaDB does not support serverless instances.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'Prepaid', ], ], [ 'name' => 'Engine', 'in' => 'query', 'schema' => [ 'description' => 'The database engine that is run by the instance. Valid values:'."\n" ."\n" .'* **MySQL**'."\n" .'* **SQLServer**'."\n" .'* **PostgreSQL**'."\n" .'* **MariaDB**', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MySQL', ], ], [ 'name' => 'EngineVersion', 'in' => 'query', 'schema' => [ 'description' => 'The database engine version of the instance. Valid values:'."\n" ."\n" .'* Regular instance'."\n" ."\n" .' * Valid values if you set Engine to MySQL: **5.5, 5.6, 5.7, and 8.0**'."\n" .' * Valid values if you set Engine to SQLServer: **2008r2, 08r2\\_ent_ha, 2012, 2012\\_ent_ha, 2012\\_std_ha, 2012\\_web, 2014\\_std_ha, 2016\\_ent_ha, 2016\\_std_ha, 2016\\_web, 2017\\_std_ha, 2017\\_ent, 2019\\_std_ha, and 2019\\_ent**'."\n" .' * Valid values if you set Engine to PostgreSQL: **10.0, 11.0, 12.0, 13.0, 14.0, and 15.0**'."\n" .' * Valid value when you set Engine to MariaDB: **10.3**'."\n" ."\n" .'* Serverless instance'."\n" ."\n" .' * Valid values if you set Engine to MySQL: **5.7** and **8.0**'."\n" .' * Valid values if you set Engine to SQLServer: **2016\\_std_sl**, **2017\\_std_sl**, and **2019\\_std_sl**'."\n" .' * Valid value if you set Engine to PostgreSQL: **14.0**'."\n" ."\n" .' > ApsaraDB RDS for MariaDB does not support serverless instances.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '8.0', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'rm-uf6wjk5xxxxxx', ], ], [ 'name' => 'OrderType', 'in' => 'query', 'schema' => [ 'description' => 'The type of order. Set the value to **BUY**'."\n", 'type' => 'string', 'required' => false, 'example' => 'BUY', 'default' => 'BUY', ], ], [ 'name' => 'DBInstanceStorageType', 'in' => 'query', 'schema' => [ 'description' => 'The storage type of the instance. Valid values:'."\n" ."\n" .'* **local_ssd**: local SSD. This is the recommended storage type.'."\n" .'* **cloud_ssd**: standard SSD.'."\n" .'* **cloud_essd**: performance level 1 (PL1) Enterprise SSD (ESSD)'."\n" .'* **cloud_essd2**: PL2 ESSD'."\n" .'* **cloud_essd3**: PL3 ESSD'."\n" ."\n" .'> Serverless instances use only PL1 ESSDs. If you want to create a serverless instance, you must set this parameter to **cloud_essd**.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'local_ssd', ], ], [ 'name' => 'Category', 'in' => 'query', 'schema' => [ 'description' => 'The RDS edition of the instance. Valid values:'."\n" ."\n" .'* Regular instance'."\n" ."\n" .' * **Basic**: RDS Basic Edition'."\n" .' * **HighAvailability**: RDS High-availability Edition'."\n" .' * **cluster**: RDS Cluster Edition for ApsaraDB RDS for MySQL'."\n" .' * **AlwaysOn**: RDS Cluster Edition for ApsaraDB RDS for SQL Server'."\n" .' * **Finance**: RDS Enterprise Edition'."\n" ."\n" .'* Serverless instance'."\n" ."\n" .' * **serverless_basic**: RDS Basic Edition. This edition is available only for serverless instances that run MySQL and PostgreSQL.'."\n" .' * **serverless_standard**: RDS High-availability Edition for ApsaraDB RDS for MySQL.'."\n" .' * **serverless_ha**: RDS High-availability Edition for ApsaraDB RDS for SQL Server.'."\n" ."\n" .' > If you create a serverless instance, you must specify this parameter.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'HighAvailability', ], ], [ 'name' => 'CommodityCode', 'in' => 'query', 'schema' => [ 'description' => 'The commodity code of the instance. Valid values:'."\n" ."\n" .'* **bards**: The instance is a pay-as-you-go primary instance. This value is available at the China site (aliyun.com).'."\n" .'* **rds**: The instance is a subscription primary instance. This value is available at the China site (aliyun.com).'."\n" .'* **rords**: The instance is a pay-as-you-go read-only instance. This value is available at the China site (aliyun.com).'."\n" .'* **rds_rordspre_public_cn**: The instance is a subscription read-only instance. This value is available at the China site (aliyun.com).'."\n" .'* **bards_intl**: The instance is a pay-as-you-go primary instance. This value is available at the International site (alibabacloud.com).'."\n" .'* **rds_intl**: The instance is a subscription primary instance. This value is available at the International site (alibabacloud.com).'."\n" .'* **rords_intl**: The instance is a pay-as-you-go read-only instance. This value is available at the International site (alibabacloud.com).'."\n" .'* **rds_rordspre_public_intl**: The instance is a subscription read-only instance. This value is available at the International site (alibabacloud.com).'."\n" .'* **rds_serverless_public_cn**: The instance is a serverless instance. This value is available at the China site (aliyun.com).'."\n" .'* **rds_serverless_public_intl**: The instance is a serverless instance. This value is available at the International site (alibabacloud.com).'."\n" ."\n" .'> If you want to query the price of a read-only instance, you must specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'bards', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'DBInstanceClasses' => [ 'description' => 'An array that consists of the instance types available for the instance.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'DBInstanceClass' => [ 'description' => 'The instance type of the instance.'."\n", 'type' => 'string', 'example' => 'rds.mysql.c1.large', ], 'DBInstanceStorageRange' => [ 'description' => 'The storage capacity range that is supported for the instance.'."\n", 'type' => 'object', 'properties' => [ 'MaxValue' => [ 'description' => 'The maximum storage capacity that is supported for the instance. Unit: GB.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2000', ], 'MinValue' => [ 'description' => 'The minimum storage capacity that is supported for the instance. Unit: GB.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'Step' => [ 'description' => 'The minimum step size at which you can adjust the storage capacity of the instance. The minimum step size is 5 GB.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], ], ], ], ], ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '7E4448A6-9FE6-4474-A0C1-AA7CFC772CAC', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'ArticleNotFound', 'errorMessage' => 'Article not found', ], [ 'errorCode' => 'InvalidDBInstanceName', 'errorMessage' => 'The specified parameter DBInstanceName is null or the instance cannot be found, please check parameter DBInstanceName.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'DBInstanceName not found', ], [ 'errorCode' => 'InvalidCondition.NotFound', 'errorMessage' => 'No class found', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBInstanceClasses\\": [\\n {\\n \\"DBInstanceClass\\": \\"rds.mysql.c1.large\\",\\n \\"DBInstanceStorageRange\\": {\\n \\"MaxValue\\": 2000,\\n \\"MinValue\\": 5,\\n \\"Step\\": 5\\n }\\n }\\n ],\\n \\"RequestId\\": \\"7E4448A6-9FE6-4474-A0C1-AA7CFC772CAC\\"\\n}","errorExample":""},{"type":"xml","example":"\\n\\n rds.mysql.c1.large\\n \\n 5\\n 2000\\n 5\\n \\n\\n\\n rds.mysql.st.v52\\n \\n 1000\\n 6000\\n 5\\n \\n\\n7E4448A6-9FE6-4474-A0C1-AA7CFC772CAC\\n","errorExample":""}]', 'title' => 'DescribeAvailableClasses', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" .'* MariaDB'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeDBInstanceAttribute' => [ 'summary' => 'Queries the details of an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n" ."\n" .'>Do not query the details of multiple instances at a time by using multiple instance IDs. Otherwise, the query times out and fails.>', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5*****', ], ], [ 'name' => 'Expired', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether the instance expires. Valid values:'."\n" ."\n" .'* **True**'."\n" .'* **False**'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'False', 'default' => 'False', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Items' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'DBInstanceAttribute' => [ 'description' => 'The details of instances.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details of the instance.'."\n", 'type' => 'object', 'properties' => [ 'AccountMaxQuantity' => [ 'description' => 'The maximum number of accounts that can be created on the instance.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '50', ], 'AdvancedFeatures' => [ 'description' => 'The advanced features that are enabled for the instance. If multiple advanced features are enabled, the advanced features are separated by commas (,). This parameter is available only to instances that run **SQL Server**. Valid values:'."\n" ."\n" .'* **LinkedServer**'."\n" .'* **DistributeTransaction**'."\n", 'type' => 'string', 'example' => 'LinkedServer', ], 'AutoUpgradeMinorVersion' => [ 'description' => 'The method that is used to update the minor engine version of the instance. Valid values:'."\n" ."\n" .'* **Auto**: automatic update.'."\n" .'* **Manual**: manual update. The minor engine version of the instance is forcefully updated only when the in-use minor engine version is phased out.'."\n", 'type' => 'string', 'example' => 'Auto', ], 'AvailabilityValue' => [ 'description' => 'The availability status of the instance in percentage.'."\n", 'type' => 'string', 'example' => '100.0%', ], 'BabelfishConfig' => [ 'description' => 'The configuration of the Babelfish feature for the ApsaraDB RDS for PostgreSQL instance.'."\n" ."\n" .'> This parameter applies only to ApsaraDB RDS for PostgreSQL instances for which Babelfish is enabled. For more information, see [Introduction to Babelfish](~~428613~~).'."\n", 'type' => 'object', 'properties' => [ 'BabelfishEnabled' => [ 'description' => 'Indicates whether Babelfish is enabled.'."\n" ."\n" .'> If Babelfish is enabled when you purchase an ApsaraDB RDS for PostgreSQL instance, this parameter is fixed as **true**.'."\n", 'type' => 'string', 'example' => 'true', ], 'MigrationMode' => [ 'description' => 'The migration mode for Babelfish. Valid values:'."\n" ."\n" .'* **single-db**'."\n" .'* **multi-db**'."\n" ."\n" .'> For more information about migration modes for Babelfish, see [Migration modes](~~428613~~).'."\n", 'type' => 'string', 'example' => 'single-db', ], ], ], 'IsAnalyticIns' => [ 'type' => 'boolean', ], 'CanTempUpgrade' => [ 'description' => 'Indicates whether the conditions for a temporary upgrade are met.'."\n" ."\n" .'> Pay-as-you-go instances do not support temporary upgrades.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Category' => [ 'description' => 'The RDS edition. Valid values:'."\n" ."\n" .'* **Basic**: RDS Basic Edition'."\n" .'* **HighAvailability**: RDS High-availability Edition'."\n" .'* **cluster**: RDS Cluster Edition for ApsaraDB RDS for MySQL'."\n" .'* **AlwaysOn**: RDS Cluster Edition for ApsaraDB RDS for SQL Server'."\n" .'* **Finance**: RDS Enterprise Edition'."\n" .'* **Serverless_basic**: RDS Basic Edition for serverless instances'."\n", 'type' => 'string', 'example' => 'Basic', ], 'ColdDataEnabled' => [ 'description' => 'Indicates whether the data archiving feature is enabled for Premium ESSDs. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n" ."\n" .'For more information about the data archiving feature, see [Use the data archiving feature](~~2701832~~).'."\n", 'type' => 'boolean', 'example' => 'None', ], 'Collation' => [ 'description' => 'The character set collation of the instance.'."\n", 'type' => 'string', 'example' => 'Chinese_PRC_CI_AS', ], 'ConnectionMode' => [ 'description' => 'The connection mode of the instance. Valid values:'."\n" ."\n" .'* **Standard**: standard mode'."\n" .'* **Safe**: database proxy mode'."\n", 'type' => 'string', 'example' => 'Standard', ], 'ConnectionString' => [ 'description' => 'The internal endpoint.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5*****.mysql.rds.aliyuncs.com', ], 'ConsoleVersion' => [ 'description' => 'The type of the proxy that is used by the instance. Valid values:'."\n" ."\n" .'* **1**: shared database proxy'."\n" .'* **2**: dedicated database proxy'."\n" ."\n" .'> We recommend that you use the **ProxyType** parameter instead of this parameter.'."\n", 'type' => 'string', 'example' => '2', ], 'CreationTime' => [ 'description' => 'The creation time. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2011-05-30T12:11:04Z', ], 'CurrentKernelVersion' => [ 'description' => 'The minor engine version.'."\n", 'type' => 'string', 'example' => 'rds_20181010', ], 'DBClusterNodes' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'DBClusterNode' => [ 'description' => 'The information about the node in the cluster.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details of the node.'."\n", 'type' => 'object', 'properties' => [ 'ClassCode' => [ 'description' => 'The node specification.'."\n", 'type' => 'string', 'example' => 'mysql.n2.medium.xc', ], 'ClassType' => [ 'description' => 'The node type. Default value: true. Valid values:'."\n" ."\n" .'* d: dedicated node type'."\n" .'* x: general-purpose node type'."\n", 'type' => 'string', 'example' => 'x', ], 'Cpu' => [ 'description' => 'The number of CPU cores of the node.'."\n", 'type' => 'string', 'example' => '4', ], 'Memory' => [ 'description' => 'The memory capacity of the node. Unit: MB.'."\n", 'type' => 'string', 'example' => '4096', ], 'NodeId' => [ 'description' => 'The node ID.'."\n", 'type' => 'string', 'example' => 'rn-****', ], 'NodeRegionId' => [ 'description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-beijing', ], 'NodeRole' => [ 'description' => 'The role of the node. Valid values:'."\n" ."\n" .'* **primary**'."\n" .'* **secondary**'."\n", 'type' => 'string', 'example' => 'primary', ], 'NodeZoneId' => [ 'description' => 'The zone ID.'."\n", 'type' => 'string', 'example' => 'cn-beijing-h', ], 'Status' => [ 'description' => 'The node status. Valid values:'."\n" ."\n" .'* active'."\n" .'* creating'."\n" .'* deleting'."\n" .'* classchanging'."\n" .'* restarting'."\n", 'type' => 'string', 'example' => 'active', ], 'DisasterRecoveryNode' => [ 'type' => 'boolean', ], ], ], ], ], ], 'DBInstanceCPU' => [ 'description' => 'The number of CPU cores.'."\n", 'type' => 'string', 'example' => '2', ], 'DBInstanceClass' => [ 'description' => 'The instance type of the instance. For more information, see [Primary ApsaraDB RDS instance types](~~26312~~).'."\n", 'type' => 'string', 'example' => 'rds.mys2.small', ], 'DBInstanceClassType' => [ 'description' => 'The instance family. Valid values:'."\n" ."\n" .'* **s**: shared instance family'."\n" .'* **x**: general-purpose instance family'."\n" .'* **d**: dedicated instance family'."\n" .'* **h**: dedicated host instance family'."\n", 'type' => 'string', 'example' => 's', ], 'DBInstanceDescription' => [ 'description' => 'The instance description.'."\n", 'type' => 'string', 'example' => 'The number of cores that are configured for the instance.'."\n", ], 'DBInstanceDiskUsed' => [ 'description' => 'The disk usage of the instance. Unit: byte.'."\n", 'type' => 'string', 'example' => '300', ], 'DBInstanceId' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5*****', ], 'DBInstanceMemory' => [ 'description' => 'The memory capacity of the instance. Unit: MB.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '4096', ], 'DBInstanceNetType' => [ 'description' => 'The type of the network over which the instance is connected. Valid values:'."\n" ."\n" .'* **Internet**'."\n" .'* **Intranet**'."\n", 'type' => 'string', 'example' => 'Internet', ], 'DBInstanceStatus' => [ 'description' => 'The instance status. For more information, see [Instance statuses](~~26315~~).'."\n", 'type' => 'string', 'example' => 'Running', ], 'DBInstanceStorage' => [ 'description' => 'The storage capacity of the instance. Unit: GB.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'DBInstanceStorageType' => [ 'description' => 'The storage type of the instance. Valid values:'."\n" ."\n" .'* **local_ssd** and **ephemeral_ssd**: Premium Local SSD'."\n" .'* **cloud_ssd**: standard SSD'."\n" .'* **cloud_essd**: ESSD'."\n" .'* **cloud_essd**: Premium ESSD'."\n", 'type' => 'string', 'example' => 'local_ssd', ], 'DBInstanceType' => [ 'description' => 'The type of the instance. Valid values:'."\n" ."\n" .'* **Primary**: primary instance'."\n" .'* **Readonly**: read-only instance'."\n" .'* **Guard**: disaster recovery instance'."\n" .'* **Temp**: temporary instance'."\n", 'type' => 'string', 'example' => 'Primary', ], 'DBMaxQuantity' => [ 'description' => 'The maximum number of databases that can be created on the instance.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'DedicatedHostGroupId' => [ 'description' => 'The ID of the dedicated cluster to which the instance belongs.'."\n", 'type' => 'string', 'example' => 'dhg-7a9*****', ], 'DeletionProtection' => [ 'description' => 'Indicates whether the release protection feature is enabled. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'DisasterRecoveryInfo' => [ 'description' => 'Disaster Recovery Instance Information'."\n", 'type' => 'string', 'example' => '{"replicatorAccount": "******","sourcePort":******,"sourceAddress": "pgm-2ze******","sourceCategory": "aliyunRDS","sourceInstanceRegionId": "cn-******","replicatorPassword": "******","sourceInstanceName": "pgm-2ze******"}', ], 'DisasterRecoveryInstances' => [ 'description' => 'All disaster recovery instances of the current instance.'."\n", 'type' => 'string', 'example' => '[{"regionId":"cn-******","insName":"pgm-2ze******"},{"regionId":"cn-******","insName":"pgm-2ze******"}]', ], 'Engine' => [ 'description' => 'The database engine of the instance. Valid values:'."\n" ."\n" .'* **MySQL**'."\n" .'* **PostgreSQL**'."\n" .'* **SQLServer**'."\n" .'* **MariaDB**'."\n", 'type' => 'string', 'example' => 'MySQL', ], 'EngineVersion' => [ 'description' => 'The database engine version.'."\n", 'type' => 'string', 'example' => '5.5', ], 'ExpireTime' => [ 'description' => 'The expiration time of the instance. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is displayed in UTC.'."\n" ."\n" .'> Pay-as-you-go instances never expire.'."\n", 'type' => 'string', 'example' => '2019-03-27T16:00:00Z', ], 'Extra' => [ 'description' => 'The extended information about the instance.'."\n", 'type' => 'object', 'properties' => [ 'AccountSecurityPolicy' => [ 'description' => 'The group policy of the instance account.'."\n" ."\n" .'* MaximumPasswordAge: maximum use time'."\n" .'* MinimumPasswordAge: minimum use time'."\n", 'type' => 'string', 'example' => '{"MaximumPasswordAge": 42,"MinimumPasswordAge": 30}', ], 'DBInstanceIds' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'DBInstanceId' => [ 'description' => 'The instance IDs.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5*****', ], ], ], ], 'RecoveryModel' => [ 'description' => 'The recovery model. Valid values: Simple and Full.'."\n", 'type' => 'string', 'enumValueTitles' => [], 'example' => 'Simple', ], ], ], 'GeneralGroupName' => [ 'description' => 'The name of the dedicated cluster to which the instance belongs. This parameter is returned only when the instance is created in an ApsaraDB MyBase cluster that runs MySQL on Standard Edition.'."\n", 'type' => 'string', 'example' => 'TestGroup', ], 'GuardDBInstanceId' => [ 'description' => 'The ID of the disaster recovery instance that is attached to the primary instance.'."\n", 'type' => 'string', 'example' => 'rm-uf64zsu*****', ], 'IPType' => [ 'description' => 'The IP address type. Only **IPv4 addresses** are supported.'."\n", 'type' => 'string', 'example' => 'IPv4', ], 'IncrementSourceDBInstanceId' => [ 'description' => 'The ID of the instance from which incremental data comes. The incremental data of a disaster recovery instance comes from its primary instance. The incremental data of a read-only instance comes from its primary instance. If this parameter is not returned, the instance is a primary instance.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5*****', ], 'InstanceNetworkType' => [ 'description' => 'The network type of the instance. Valid values:'."\n" ."\n" .'* **Classic**'."\n" .'* **VPC**'."\n", 'type' => 'string', 'example' => 'Classic', ], 'InstructionSetArch' => [ 'description' => 'The architecture type of the instance. Valid values:'."\n" ."\n" .'* **x86**'."\n" .'* **arm**'."\n", 'type' => 'string', 'example' => 'x86', ], 'IoAccelerationEnabled' => [ 'description' => 'Indicates whether Buffer Pool Extension (BPE) is enabled for Premium ESSDs.'."\n" ."\n" .'* **1**: enabled'."\n" .'* **0**: disabled'."\n" ."\n" .'> For more information, see [Buffer Pool Extension(BPE)](~~2527067~~).'."\n", 'type' => 'string', 'example' => 'None', ], 'LatestKernelVersion' => [ 'description' => 'The latest minor engine version that is supported by the instance.'."\n", 'type' => 'string', 'example' => 'rds_20201031', ], 'LockMode' => [ 'description' => 'The lock mode of the instance. Valid values:'."\n" ."\n" .'* **Unlock**: The instance is not locked.'."\n" .'* **ManualLock**: The instance is manually locked.'."\n" .'* **LockByExpiration**: The instance is automatically locked due to instance expiration.'."\n" .'* **LockByRestoration**: The instance is automatically locked due to instance restoration.'."\n" .'* **LockByDiskQuota**: The instance is automatically locked due to exhausted storage space.'."\n" .'* **LockReadInstanceByDiskQuota**: The instance is a read-only instance and is automatically locked due to exhausted storage.'."\n", 'type' => 'string', 'example' => 'Unlock', ], 'LockReason' => [ 'description' => 'The reason why the instance was locked.'."\n", 'type' => 'string', 'example' => 'instance_expired', ], 'MaintainTime' => [ 'description' => 'The maintenance window of the instance. The time is displayed in UTC. The maintenance window displayed in the ApsaraDB RDS console is equal to the value of this parameter plus 8 hours.'."\n", 'type' => 'string', 'example' => '00:00Z-02:00Z', ], 'MasterInstanceId' => [ 'description' => 'The primary instance ID.'."\n" ."\n" .'> If this parameter is not returned, the instance is the primary instance.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5*****', ], 'MasterZone' => [ 'description' => 'The zone ID of the primary instance.'."\n", 'type' => 'string', 'example' => '5454284', ], 'MaxConnections' => [ 'description' => 'The maximum number of concurrent connections.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '60', ], 'MaxIOMBPS' => [ 'description' => 'The maximum I/O throughput. Unit: MB/s.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0MB/s', ], 'MaxIOPS' => [ 'description' => 'The maximum number of I/O requests per second.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '150', ], 'MultipleTempUpgrade' => [ 'description' => 'Indicates whether auto scaling is being performed on the instance. If the value **true** is returned, auto scaling is being performed on the instance. If no value is returned, auto scaling is not being performed on the instance.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'PGBouncerEnabled' => [ 'description' => 'Indicates whether PgBouncer is enabled.'."\n" ."\n" .'> This parameter is returned only for RDS instances that run PostgreSQL. If PgBouncer is enabled, the return value is **true**.'."\n", 'type' => 'string', 'example' => 'true', ], 'PayType' => [ 'description' => 'The billing method of the instance. Valid values:'."\n" ."\n" .'* **Postpaid**: pay-as-you-go'."\n" .'* **Prepaid**: subscription'."\n" .'* **SERVERLESS**'."\n", 'type' => 'string', 'example' => 'Postpaid', ], 'Port' => [ 'description' => 'The port that is used to connect to the instance over an internal network.'."\n", 'type' => 'string', 'example' => '3306', ], 'ProxyType' => [ 'description' => 'The type of the proxy that is supported by the instance. Valid values:'."\n" ."\n" .'* **0**: The instance does not support database proxies.'."\n" .'* **1**: The instance supports shared proxies, with which the instance runs in multi-tenant mode.'."\n" .'* **2**: The instance supports dedicated proxies, with which the instance runs in single-tenant mode.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'ReadOnlyDBInstanceIds' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'ReadOnlyDBInstanceId' => [ 'description' => 'The IDs of the read-only instances that are attached to the primary instance.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'DBInstanceId' => [ 'description' => 'The read-only instance ID.'."\n", 'type' => 'string', 'example' => 'rm-bp*****', ], ], ], ], ], ], 'ReadonlyInstanceSQLDelayedTime' => [ 'description' => 'The latency at which the system replicates data to read-only instances. The system replicates data from the primary instance to the read-only instances at the latency that is specified by the **ReadonlyInstanceSQLDelayedTime** parameter. Unit: seconds.'."\n", 'type' => 'string', 'example' => '30', ], 'RegionId' => [ 'description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou ', ], 'ResourceGroupId' => [ 'description' => 'The resource group ID.'."\n", 'type' => 'string', 'example' => 'rg-acfmy*****', ], 'SecurityIPList' => [ 'description' => 'The IP addresses in the IP address whitelist.'."\n", 'type' => 'string', 'example' => '192.168.XX.XX/24', ], 'SecurityIPMode' => [ 'description' => 'The whitelist mode. Valid values:'."\n" ."\n" .'* **normal**: standard whitelist mode'."\n" .'* **safety**: enhanced whitelist mode'."\n", 'type' => 'string', 'example' => 'normal', ], 'ServerlessConfig' => [ 'description' => 'The settings of the serverless instance.'."\n", 'type' => 'object', 'properties' => [ 'AutoPause' => [ 'description' => 'Indicates whether the automatic start and stop feature is enabled for the serverless instance. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false** (default)'."\n" ."\n" .'> After the automatic start and stop feature is enabled, if no connections to the instance are established within 10 minutes, the instance is suspended. After a connection to the instance is established, the instance is automatically resumed.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'ScaleMax' => [ 'description' => 'The maximum number of RCUs.'."\n", 'type' => 'number', 'format' => 'double', 'example' => '8', ], 'ScaleMin' => [ 'description' => 'The minimum number of RDS Capacity Units (RCUs).'."\n", 'type' => 'number', 'format' => 'double', 'example' => '0.5', ], 'SwitchForce' => [ 'description' => 'Indicates whether the forced scaling feature is enabled for the serverless instance. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false** (default)'."\n" ."\n" .'> In most cases, ApsaraDB RDS automatically scales in or out the RCUs of a serverless instance based on business requirements in real time. In rare cases, the scaling does not take effect in real time. You can enable the forced scaling feature to forcefully scales in or out the RCUs of the instance.'."\n", 'type' => 'boolean', 'example' => 'false', ], ], ], 'SlaveZones' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'SlaveZone' => [ 'description' => 'The zone IDs of the secondary instances.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The following information is returned.'."\n", 'type' => 'object', 'properties' => [ 'ZoneId' => [ 'description' => 'The zone ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou-a', ], ], ], ], ], ], 'SuperPermissionMode' => [ 'description' => 'Indicates whether the instance supports superuser accounts, such as the system administrator (SA) account, Active Directory (AD) account, and host account. Valid values:'."\n" ."\n" .'* **Enable**'."\n" .'* **Disabled**'."\n", 'type' => 'string', 'example' => 'Disabled', ], 'TempDBInstanceId' => [ 'description' => 'The ID of the temporary instance that is attached to the primary instance.'."\n", 'type' => 'string', 'example' => 'rm-uf64zsu*****', ], 'TempUpgradeTimeEnd' => [ 'description' => 'The end time of the temporary upgrade of the instance.'."\n" ."\n" .'> This parameter is unavailable for pay-as-you-go instances.'."\n", 'type' => 'string', 'example' => '2024-05-30 00:00:00', ], 'TempUpgradeTimeStart' => [ 'description' => 'The start time of the temporary upgrade of the instance.'."\n" ."\n" .'> This parameter is unavailable for pay-as-you-go instances.'."\n", 'type' => 'string', 'example' => '2024-05-29 00:00:00', ], 'TimeZone' => [ 'description' => 'The time zone.'."\n", 'type' => 'string', 'example' => 'Central Standard Time', ], 'Tips' => [ 'description' => 'The information about the exception that is detected on the instance. This parameter is returned only when the instance is created in an ApsaraDB MyBase cluster that runs MySQL on Standard Edition.'."\n", 'type' => 'string', 'example' => 'The IP addresses in the IP address whitelist.'."\n", ], 'TipsLevel' => [ 'description' => 'The severity of the exception that is detected on the instance. This parameter is returned only when the instance is created in an ApsaraDB MyBase cluster that runs MySQL on Standard Edition. Valid values:'."\n" ."\n" .'* **1**: The instance is normal.'."\n" .'* **2**: The specifications of the read-only instances do not match the specifications of the primary instance. You must adjust the specifications of these instances based on your business requirements.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'VSwitchId' => [ 'description' => 'The vSwitch ID.'."\n", 'type' => 'string', 'example' => 'vsw-*****', ], 'VpcCloudInstanceId' => [ 'description' => 'The ID of the VPC. This parameter is returned only when the instance resides in a VPC.'."\n", 'type' => 'string', 'example' => 'vpc-23rsxdf*****', ], 'VpcId' => [ 'description' => 'The VPC ID.'."\n", 'type' => 'string', 'example' => 'vpc-*****', ], 'ZoneId' => [ 'description' => 'The zone ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou-a', ], 'kindCode' => [ 'description' => 'An internal parameter. You do not need to specify this parameter.'."\n", 'type' => 'string', 'example' => 'The architecture type of the instance. Valid values:'."\n" ."\n" .'- **x86**'."\n" .'- **arm**', ], 'OptimizedWritesInfo' => [ 'description' => 'The OptimizedWritesInfo parameter contains the following fields:'."\n" .'* **optimized_writes**: indicates whether the 16K atomic write feature is enabled for the current instance.'."\n" .'* **init_optimized_writes**: indicates whether the 16K atomic write feature can be enabled for the current instance. If init_optimized_writes is set to false, the 16K atomic write switch is not displayed for the instance in the console.', 'type' => 'string', 'example' => '{"optimized_writes":true,"init_optimized_writes":true}', ], 'CompressionMode' => [ 'description' => 'The storage compression mode of the instance.', 'type' => 'string', 'example' => 'on, off', ], 'SupportCompression' => [ 'description' => 'Indicates whether storage compression can be enabled for the instance.', 'type' => 'boolean', 'example' => 'true, false', ], 'CompressionRatio' => [ 'description' => 'The storage compression ratio.', 'type' => 'string', 'example' => '1.25', ], 'BlueGreenDeploymentName' => [ 'description' => 'This is a reserved parameter and is not in use.', 'type' => 'string', 'example' => 'None', ], 'GreenInstanceName' => [ 'description' => 'This is a reserved parameter and is not in use.', 'type' => 'string', 'example' => 'None', ], 'BlueInstanceName' => [ 'description' => 'This is a reserved parameter and is not in use.', 'type' => 'string', 'example' => 'None', ], 'ComputeBurstEnabled' => [ 'description' => 'This is a reserved parameter and is not in use.', 'type' => 'boolean', 'example' => 'None', ], 'ReadOnlyStatus' => [ 'description' => 'This is a reserved parameter and is not in use.', 'type' => 'string', 'example' => 'None', ], 'BurstingEnabled' => [ 'description' => 'Indicates whether the I/O burst feature is enabled for Premium ESSDs. Valid values:'."\n" ."\n" .'* true'."\n" .'* false'."\n" ."\n" .'> For more information about the I/O burst feature, see [What are Premium ESSDs?](~~2340501~~)'."\n", 'type' => 'boolean', 'example' => 'false', ], 'IsAnalyticReadOnlyIns' => [ 'type' => 'boolean', ], 'VectorSupportStatus' => [ 'title' => '向量支持状态', 'type' => 'string', 'example' => 'ON', 'enum' => [ 'None', 'ON', 'OFF', ], ], ], ], ], ], ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'ConnectTimeoutRetryLater', 'errorMessage' => 'Connect timeout retry later.', ], [ 'errorCode' => 'TimeoutRetryLater', 'errorMessage' => 'Timeout, please retry later.', ], [ 'errorCode' => 'DataNotExist', 'errorMessage' => 'Data not exist.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The specified DB instance name does not exist.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Items\\": {\\n \\"DBInstanceAttribute\\": [\\n {\\n \\"AccountMaxQuantity\\": 50,\\n \\"AdvancedFeatures\\": \\"LinkedServer\\",\\n \\"AutoUpgradeMinorVersion\\": \\"Auto\\",\\n \\"AvailabilityValue\\": \\"100.0%\\",\\n \\"BabelfishConfig\\": {\\n \\"BabelfishEnabled\\": \\"true\\",\\n \\"MigrationMode\\": \\"single-db\\"\\n },\\n \\"BpeEnabled\\": \\"0\\",\\n \\"IsAnalyticIns\\": true,\\n \\"CanTempUpgrade\\": true,\\n \\"Category\\": \\"Basic\\",\\n \\"ColdDataEnabled\\": false,\\n \\"Collation\\": \\"Chinese_PRC_CI_AS\\",\\n \\"ConnectionMode\\": \\"Standard\\",\\n \\"ConnectionString\\": \\"rm-uf6wjk5****.mysql.rds.aliyuncs.com\\",\\n \\"ConsoleVersion\\": \\"2\\",\\n \\"CreationTime\\": \\"2011-05-30T12:11:04Z\\",\\n \\"CurrentKernelVersion\\": \\"rds_20201010\\",\\n \\"DBClusterNodes\\": {\\n \\"DBClusterNode\\": [\\n {\\n \\"ClassCode\\": \\"mysql.n2.medium.xc\\",\\n \\"ClassType\\": \\"x\\",\\n \\"Cpu\\": \\"4\\",\\n \\"Memory\\": \\"4096\\",\\n \\"NodeId\\": \\"rn-****\\",\\n \\"NodeRegionId\\": \\"cn-beijing\\",\\n \\"NodeRole\\": \\"primary\\",\\n \\"NodeZoneId\\": \\"cn-beijing-h\\",\\n \\"Status\\": \\"active\\",\\n \\"DisasterRecoveryNode\\": true\\n }\\n ]\\n },\\n \\"DBInstanceCPU\\": \\"2\\",\\n \\"DBInstanceClass\\": \\"rds.mys2.small\\",\\n \\"DBInstanceClassType\\": \\"s\\",\\n \\"DBInstanceDescription\\": \\"testInstance\\",\\n \\"DBInstanceDiskUsed\\": \\"300\\",\\n \\"DBInstanceId\\": \\"rm-uf6wjk5****\\",\\n \\"DBInstanceMemory\\": 4096,\\n \\"DBInstanceNetType\\": \\"Internet\\",\\n \\"DBInstanceStatus\\": \\"Running\\",\\n \\"DBInstanceStorage\\": 10,\\n \\"DBInstanceStorageType\\": \\"local_ssd\\",\\n \\"DBInstanceType\\": \\"Primary\\",\\n \\"DBMaxQuantity\\": 200,\\n \\"DedicatedHostGroupId\\": \\"dhg-7a9*****\\",\\n \\"DeletionProtection\\": true,\\n \\"DisasterRecoveryInfo\\": \\"{\\\\\\"replicatorAccount\\\\\\": \\\\\\"******\\\\\\",\\\\\\"sourcePort\\\\\\":******,\\\\\\"sourceAddress\\\\\\": \\\\\\"pgm-2ze******\\\\\\",\\\\\\"sourceCategory\\\\\\": \\\\\\"aliyunRDS\\\\\\",\\\\\\"sourceInstanceRegionId\\\\\\": \\\\\\"cn-******\\\\\\",\\\\\\"replicatorPassword\\\\\\": \\\\\\"******\\\\\\",\\\\\\"sourceInstanceName\\\\\\": \\\\\\"pgm-2ze******\\\\\\"}\\",\\n \\"DisasterRecoveryInstances\\": \\"[{\\\\\\"regionId\\\\\\":\\\\\\"cn-******\\\\\\",\\\\\\"insName\\\\\\":\\\\\\"pgm-2ze******\\\\\\"},{\\\\\\"regionId\\\\\\":\\\\\\"cn-******\\\\\\",\\\\\\"insName\\\\\\":\\\\\\"pgm-2ze******\\\\\\"}]\\",\\n \\"Engine\\": \\"MySQL\\",\\n \\"EngineVersion\\": \\"8.0\\",\\n \\"ExpireTime\\": \\"2019-03-27T16:00:00Z\\",\\n \\"Extra\\": {\\n \\"AccountSecurityPolicy\\": \\"{\\\\\\"MaximumPasswordAge\\\\\\": 42,\\\\\\"MinimumPasswordAge\\\\\\": 30}\\",\\n \\"DBInstanceIds\\": {\\n \\"DBInstanceId\\": [\\n \\"rm-uf6wjk5****\\"\\n ]\\n },\\n \\"RecoveryModel\\": \\"Simple：简单恢复模式。\\\\nFull：完整恢复模式。\\"\\n },\\n \\"GeneralGroupName\\": \\"TestGroup\\",\\n \\"GuardDBInstanceId\\": \\"rm-uf64zsu****\\",\\n \\"IPType\\": \\"IPv4\\",\\n \\"IncrementSourceDBInstanceId\\": \\"rm-uf6wjk5****\\",\\n \\"InstanceNetworkType\\": \\"Classic\\",\\n \\"InstructionSetArch\\": \\"x86\\",\\n \\"IoAccelerationEnabled\\": \\"0\\",\\n \\"LatestKernelVersion\\": \\"rds_20231031\\",\\n \\"LockMode\\": \\"Unlock\\",\\n \\"LockReason\\": \\"instance_expired\\",\\n \\"MaintainTime\\": \\"00:00Z-02:00Z\\",\\n \\"MasterInstanceId\\": \\"rm-uf6wjk5****\\",\\n \\"MasterZone\\": \\"5454284\\",\\n \\"MaxConnections\\": 60,\\n \\"MaxIOMBPS\\": 100,\\n \\"MaxIOPS\\": 150,\\n \\"MultipleTempUpgrade\\": true,\\n \\"PGBouncerEnabled\\": \\"true\\",\\n \\"PayType\\": \\"Postpaid\\",\\n \\"Port\\": \\"3306\\",\\n \\"ProxyType\\": 1,\\n \\"ReadOnlyDBInstanceIds\\": {\\n \\"ReadOnlyDBInstanceId\\": [\\n {\\n \\"DBInstanceId\\": \\"rm-bp****\\"\\n }\\n ]\\n },\\n \\"ReadonlyInstanceSQLDelayedTime\\": \\"30\\",\\n \\"RegionId\\": \\"cn-hangzhou \\",\\n \\"ResourceGroupId\\": \\"rg-acfmy****\\",\\n \\"SecurityIPList\\": \\"192.168.XX.XX/24\\",\\n \\"SecurityIPMode\\": \\"normal\\",\\n \\"ServerlessConfig\\": {\\n \\"AutoPause\\": true,\\n \\"ScaleMax\\": 8,\\n \\"ScaleMin\\": 0.5,\\n \\"SwitchForce\\": false\\n },\\n \\"SlaveZones\\": {\\n \\"SlaveZone\\": [\\n {\\n \\"ZoneId\\": \\"cn-hangzhou-a\\"\\n }\\n ]\\n },\\n \\"SuperPermissionMode\\": \\"Disabled\\",\\n \\"TempDBInstanceId\\": \\"rm-uf64zsu****\\",\\n \\"TempUpgradeTimeEnd\\": \\"2024-05-30 00:00:00\\",\\n \\"TempUpgradeTimeStart\\": \\"2024-05-29 00:00:00\\",\\n \\"TimeZone\\": \\"Central Standard Time\\",\\n \\"Tips\\": \\"normal\\",\\n \\"TipsLevel\\": 1,\\n \\"VSwitchId\\": \\"vsw-****\\",\\n \\"VpcCloudInstanceId\\": \\"vpc-23rsxdf****\\",\\n \\"VpcId\\": \\"vpc-****\\",\\n \\"ZoneId\\": \\"cn-hangzhou-a\\",\\n \\"kindCode\\": \\"test\\",\\n \\"OptimizedWritesInfo\\": \\"{\\\\\\"optimized_writes\\\\\\":true,\\\\\\"init_optimized_writes\\\\\\":true}\\",\\n \\"CompressionMode\\": \\"on, off\\",\\n \\"SupportCompression\\": true,\\n \\"CompressionRatio\\": \\"1.25\\",\\n \\"BlueGreenDeploymentName\\": \\"None\\",\\n \\"GreenInstanceName\\": \\"None\\",\\n \\"BlueInstanceName\\": \\"None\\",\\n \\"ComputeBurstEnabled\\": true,\\n \\"ReadOnlyStatus\\": \\"None\\",\\n \\"BurstingEnabled\\": false,\\n \\"IsAnalyticReadOnlyIns\\": false,\\n \\"VectorSupportStatus\\": \\"ON\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 1AD222E9-E606-4A42-BF6D-8A4442913CEF\\n \\n vpc-*****\\n 2011-05-30T12:11:04Z\\n rm-uf6wjk5*****\\n 00:00Z-02:00Z\\n Postpaid\\n 100.0%\\n 5.5\\n dhg-7a9*****\\n rm-uf6wjk5*****.mysql.rds.aliyuncs.com\\n Disabled\\n Classic\\n rm-uf6wjk5*****\\n Auto\\n 2019-03-27T16:00:00Z\\n 50\\n 5454284\\n rm-uf64zsu*****\\n 10\\n Central Standard Time\\n rds_20201031\\n 1\\n cn-hangzhou-a\\n 60\\n rm-uf6wjk5*****\\n rm-uf64zsu*****\\n LinkedServer\\n local_ssd\\n 4096\\n IPv4\\n 2\\n Standard\\n 3306\\n Unlock\\n TestGroup\\n vpc-23rsxdf*****\\n Chinese_PRC_CI_AS\\n 150\\n 一切正常\\n 192.168.XX.XX/24\\n normal\\n s\\n 1\\n rds_20181010\\n 测试数据库\\n 2\\n Internet\\n Primary\\n instance_expired\\n Running\\n 200\\n cn-hangzhou \\n 30\\n vsw-*****\\n rg-acfmy*****\\n Basic\\n rds.mys2.small\\n MySQL\\n \\n cn-hangzhou-a\\n \\n \\n rm-bp*****\\n \\n \\n rm-uf6wjk5*****\\n \\n true\\n \\n 0.5\\n 8\\n true\\n false\\n \\n \\n true\\n single-db\\n \\n 无\\n x86\\n \\n cn-beijing\\n cn-beijing-h\\n rn-****\\n primary\\n mysql.n2.medium.xc\\n \\n \\n","errorExample":""}]', 'title' => 'DescribeDBInstanceAttribute', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* RDS MySQL'."\n" .'* RDS PostgreSQL'."\n" .'* RDS SQL Server'."\n" .'* RDS MariaDB'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'GetDBInstanceTopology' => [ 'summary' => 'Queries the topology of an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5*******', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Code' => [ 'description' => 'An internal parameter. You can ignore this parameter.'."\n", 'type' => 'string', 'example' => 'None', ], 'Data' => [ 'description' => 'The details about the topology.'."\n", 'type' => 'object', 'properties' => [ 'Connections' => [ 'description' => 'The network connection information of the instance.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'ConnectionString' => [ 'description' => 'The endpoint that is used to connect to the database instance.'."\n", 'type' => 'string', 'example' => 'rm-m5ezban**********.mysql.rds.aliyuncs.com', ], 'DBInstanceName' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-m5ezban**********', ], 'NetType' => [ 'description' => 'The network type of the endpoint. Valid values:'."\n" ."\n" .'* **vpc**'."\n" .'* **public**'."\n", 'type' => 'string', 'example' => 'vpc', ], 'ZoneId' => [ 'description' => 'The zone ID of the instance.'."\n", 'type' => 'string', 'example' => 'cn-qingdao-c', ], ], ], ], 'DBInstanceName' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-m5ezban**********', ], 'Nodes' => [ 'description' => 'The queried nodes.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'DBInstanceName' => [ 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'rm-m5ezban**********', ], 'DedicatedHostGroupId' => [ 'description' => 'The ID of the dedicated cluster.'."\n" ."\n" .'> : If the instance does not reside in the specified dedicated cluster, no value is returned.'."\n", 'type' => 'string', 'example' => 'dhg-4n*****', ], 'DedicatedHostId' => [ 'description' => 'The host ID of the instance in the dedicated cluster.'."\n" ."\n" .'> : If the instance does not reside in the specified dedicated cluster, no value is returned.'."\n", 'type' => 'string', 'example' => 'i-bpxxxxxxx', ], 'NodeId' => [ 'description' => 'The ID of the instance.'."\n" ."\n" .'> : The value \\*\\*-1\\*\\* is returned for an instance that does not reside in a dedicated cluster.'."\n", 'type' => 'string', 'example' => '349054', ], 'Role' => [ 'description' => 'The type of the node. The following result is returned:'."\n" ."\n" .'* **Master**: a primary node'."\n" .'* **Slave**: a secondary node'."\n", 'type' => 'string', 'example' => 'master', ], 'ZoneId' => [ 'description' => 'The zone ID of the instance.'."\n", 'type' => 'string', 'example' => 'cn-qingdao-c', ], ], ], ], ], ], 'Message' => [ 'description' => 'An internal parameter. You can ignore this parameter.'."\n", 'type' => 'string', 'example' => 'None', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '7430AB1A-6D49-5B6D-B9E5-920250076074', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidAction', 'errorMessage' => 'Specified action is not valid.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'DBInstanceStatusNotActive', 'errorMessage' => 'The status of the current instance is not active.', ], [ 'errorCode' => 'DBTypeNotSupported', 'errorMessage' => 'The database type is not supported.', ], [ 'errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance does not exist or is not supported.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"None\\",\\n \\"Data\\": {\\n \\"Connections\\": [\\n {\\n \\"ConnectionString\\": \\"rm-m5ezban****mysql.rds.aliyuncs.com\\",\\n \\"DBInstanceName\\": \\"rm-m5ezban****\\",\\n \\"NetType\\": \\"vpc\\",\\n \\"ZoneId\\": \\"cn-qingdao-c\\"\\n }\\n ],\\n \\"DBInstanceName\\": \\"rm-m5ezban****\\",\\n \\"Nodes\\": [\\n {\\n \\"DBInstanceName\\": \\"rm-m5ezban****\\",\\n \\"DedicatedHostGroupId\\": \\"dhg-4n****\\",\\n \\"DedicatedHostId\\": \\"i-bp****\\",\\n \\"NodeId\\": \\"349054\\",\\n \\"Role\\": \\"master\\",\\n \\"ZoneId\\": \\"cn-qingdao-c\\"\\n }\\n ]\\n },\\n \\"Message\\": \\"None\\",\\n \\"RequestId\\": \\"7430AB1A-6D49-5B6D-B9E5-920250076074\\"\\n}","errorExample":""},{"type":"xml","example":"\\n CF5A551A-80EF-1D3D-8F43-6B52C1E2EF71\\n \\n \\n","errorExample":""}]', 'title' => 'GetDBInstanceTopology', 'description' => '### Supported database engines'."\n" ."\n" .'RDS MySQL', ], 'DescribeDBInstances' => [ 'summary' => 'Queries instances.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxx', ], ], [ 'name' => 'proxyId', 'in' => 'query', 'schema' => [ 'description' => 'A deprecated parameter. You do not need to configure this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'API', ], ], [ 'name' => 'Engine', 'in' => 'query', 'schema' => [ 'description' => 'The database engine of the instance. Valid values:'."\n" ."\n" .'* **MySQL**'."\n" .'* **SQLServer**'."\n" .'* **PostgreSQL**'."\n" .'* **MariaDB**'."\n" ."\n" .'By default, this operation returns the instances that run any of the supported database engines.'."\n", 'type' => 'string', 'required' => false, 'example' => 'MySQL', ], ], [ 'name' => 'ZoneId', 'in' => 'query', 'schema' => [ 'description' => 'The zone ID of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-a', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmyxxxxx', ], ], [ 'name' => 'DBInstanceStatus', 'in' => 'query', 'schema' => [ 'description' => 'The status of the instance. For more information, see [Instance states](~~26315~~).'."\n", 'type' => 'string', 'required' => false, 'example' => 'Running', ], ], [ 'name' => 'Expired', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether the instances have expired. Valid values:'."\n" ."\n" .'* **True**'."\n" .'* **False**'."\n", 'type' => 'string', 'required' => false, 'example' => 'True', 'default' => 'False', ], ], [ 'name' => 'SearchKey', 'in' => 'query', 'schema' => [ 'description' => 'The keyword that is used for fuzzy search. The keyword can be part of an instance ID or an instance description.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rm-uf6w', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rm-uf6wjk5xxxxxxx', ], ], [ 'name' => 'DBInstanceType', 'in' => 'query', 'schema' => [ 'description' => 'The role of the instance. Valid values:'."\n" ."\n" .'* **Primary**: primary instance'."\n" .'* **Readonly**: read-only instance'."\n" .'* **Guard**: disaster recovery instance'."\n" .'* **Temp**: temporary instance'."\n" ."\n" .'By default, this operation returns the instances that assume any of the supported roles.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Primary', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Valid values: **1** to **100**.'."\n" ."\n" .'Default value: **30**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '30', 'default' => '30', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => 'The page number. Pages start from 1.'."\n" ."\n" .'Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '21474836', 'minimum' => '0', 'example' => '1', 'default' => '1', ], ], [ 'name' => 'InstanceNetworkType', 'in' => 'query', 'schema' => [ 'description' => 'The network type of the instance. Valid values:'."\n" ."\n" .'* **VPC**'."\n" .'* **Classic**'."\n" ."\n" .'By default, this operation returns the instances that reside in any of the supported network types.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Classic', ], ], [ 'name' => 'VpcId', 'in' => 'query', 'schema' => [ 'description' => 'The VPC ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vpc-uf6f7l4fg90xxxxxxxxxx', ], ], [ 'name' => 'VSwitchId', 'in' => 'query', 'schema' => [ 'description' => 'The vSwitch ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vsw-uf6adz52c2pxxxxxxxxxx', ], ], [ 'name' => 'DBInstanceClass', 'in' => 'query', 'schema' => [ 'description' => 'The instance type of the instance. For information, see [Primary ApsaraDB RDS instance types](~~26312~~).'."\n", 'type' => 'string', 'required' => false, 'example' => 'rds.mys2.small', ], ], [ 'name' => 'EngineVersion', 'in' => 'query', 'schema' => [ 'description' => 'The database engine version.'."\n", 'type' => 'string', 'required' => false, 'example' => '5.7', ], ], [ 'name' => 'PayType', 'in' => 'query', 'schema' => [ 'description' => 'The billing method of the instance. Valid values:'."\n" ."\n" .'* **Postpaid**: pay-as-you-go'."\n" .'* **Prepaid**: subscription'."\n", 'type' => 'string', 'required' => false, 'example' => 'Postpaid', ], ], [ 'name' => 'ConnectionMode', 'in' => 'query', 'schema' => [ 'description' => 'The connection mode of the instance. Valid values:'."\n" ."\n" .'* **Standard**: standard mode'."\n" .'* **Safe**: database proxy mode'."\n" ."\n" .'By default, this operation queries the instances that use any of the supported connection modes.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Standard', ], ], [ 'name' => 'Tags', 'in' => 'query', 'schema' => [ 'description' => 'The tag that is added to the instance. Each tag is a key-value pair that consists of two fields: TagKey and TagValue. You can specify a maximum of five tags in the following format for each request: {"key1":"value1","key2":"value2"...}.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"key1":"value1"}', ], ], [ 'name' => 'DedicatedHostGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The dedicated cluster ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'dhg-7a9xxxxxxxx', ], ], [ 'name' => 'DedicatedHostId', 'in' => 'query', 'schema' => [ 'description' => 'The host ID of the instance in the dedicated cluster.'."\n", 'type' => 'string', 'required' => false, 'example' => 'i-bpxxxxxxx', ], ], [ 'name' => 'InstanceLevel', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to return the RDS edition of the instance by using the Category parameter. Valid values:'."\n" ."\n" .'* **0**: returns the RDS edition of the instance.'."\n" .'* **1**: does not return the RDS edition of the instance.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], ], [ 'name' => 'QueryAutoRenewal', 'in' => 'query', 'schema' => [ 'type' => 'boolean', 'required' => false, 'default' => 'false', ], ], [ 'name' => 'ConnectionString', 'in' => 'query', 'schema' => [ 'description' => 'The endpoint of the instance. You must specify this parameter only when you want to query a single instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rm-uf6wjk5xxxxxxx.mysql.rds.aliyuncs.com', ], ], [ 'name' => 'NextToken', 'in' => 'query', 'schema' => [ 'description' => 'The token that is used to display the next page. You must set this parameter to the value that is returned from the most recent call of the **DescribeDBInstances** operation for **NextToken**. If the returned entries are displayed on multiple pages, the next page can be displayed when you call this operation again with this parameter specified.'."\n", 'type' => 'string', 'required' => false, 'example' => 'o7PORW5o2TJg**********', ], ], [ 'name' => 'MaxResults', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return per page. Valid values: **1 to 100**.'."\n" ."\n" .'Default value: **30**.'."\n" ."\n" .'> If you specify this parameter, **PageSize** and **PageNumber** are unavailable.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '30', ], ], [ 'name' => 'Filter', 'in' => 'query', 'schema' => [ 'title' => '实例过滤条件参数及其值的JSON串', 'description' => 'The JSON string that consists of filter condition parameters and their values.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"babelfishEnabled":"true"}', ], ], [ 'name' => 'Category', 'in' => 'query', 'schema' => [ 'description' => 'The RDS edition of the instance. Valid values:'."\n" ."\n" .'* **Basic**: RDS Basic Edition'."\n" .'* **HighAvailability**: RDS High-availability Edition'."\n" .'* **cluster**: RDS Cluster Edition'."\n" .'* **serverless_basic**: RDS Serverless Basic Edition'."\n", 'type' => 'string', 'required' => false, 'example' => 'cluster', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Items' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'DBInstance' => [ 'description' => 'The information about the instances.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'BpeEnabled' => [ 'description' => 'A deprecated parameter.'."\n", 'type' => 'string', 'example' => '0', ], 'BurstingEnabled' => [ 'description' => 'Indicates whether the I/O burst feature is enabled. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'false', ], 'Category' => [ 'description' => 'The RDS edition of the instance. Valid values:'."\n" ."\n" .'* **Basic**: RDS Basic Edition'."\n" .'* **HighAvailability**: RDS High-availability Edition'."\n" .'* **Finance**: RDS Enterprise Edition'."\n" ."\n" .'> This parameter is returned only when the **InstanceLevel** parameter is set to **1**.'."\n", 'type' => 'string', 'example' => 'Basic', ], 'IsAnalyticReadOnlyIns' => [ 'type' => 'boolean', ], 'ConnectionMode' => [ 'description' => 'The connection mode of the instance. Valid values:'."\n" ."\n" .'* **Standard**: standard mode'."\n" .'* **Safe**: database proxy mode'."\n", 'type' => 'string', 'example' => 'Standard', ], 'ConnectionString' => [ 'description' => 'The endpoint of the instance.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5xxxxxxx.mysql.rds.aliyuncs.com', ], 'CreateTime' => [ 'description' => 'The creation time of the instance. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2018-11-05T11:26:02Z', ], 'DBInstanceCPU' => [ 'description' => 'The number of CPU instances.'."\n" ."\n" .'Returns only when the InstanceLevel parameter is 1.', 'type' => 'string', 'example' => '2', ], 'DBInstanceClass' => [ 'description' => 'The instance type of the instance. For information, see [Primary ApsaraDB RDS instance types](~~26312~~).'."\n", 'type' => 'string', 'example' => 'rds.mys2.small', ], 'DBInstanceDescription' => [ 'description' => 'The instance description.'."\n", 'type' => 'string', 'example' => 'Test database'."\n", ], 'DBInstanceId' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5xxxxxxxxxx', ], 'DBInstanceMemory' => [ 'description' => 'The memory size of the node. Unit: MB.'."\n" ."\n" .'Returns only when the InstanceLevel parameter is 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '4096', ], 'DBInstanceNetType' => [ 'description' => 'The type of the network connection to the instance. Valid values:'."\n" ."\n" .'* **Internet**'."\n" .'* **Intranet**'."\n", 'type' => 'string', 'example' => 'Internet', ], 'DBInstanceStatus' => [ 'description' => 'The instance status. For more information, see [Instance statuses](~~26315~~).'."\n", 'type' => 'string', 'example' => 'Running', ], 'DBInstanceStorageType' => [ 'description' => 'The storage type of the instance.'."\n", 'type' => 'string', 'example' => 'ModuleList.4.ModuleCode', ], 'DBInstanceType' => [ 'description' => 'The type of the instance. Valid values:'."\n" ."\n" .'* **Primary**: primary instance'."\n" .'* **Readonly**: read-only instance'."\n" .'* **Guard**: disaster recovery instance'."\n" .'* **Temp**: temporary instance'."\n", 'type' => 'string', 'example' => 'Primary', ], 'DedicatedHostGroupId' => [ 'description' => 'The ID of the dedicated cluster.'."\n", 'type' => 'string', 'example' => 'dhg-7a9xxxxxxxx', ], 'DedicatedHostGroupName' => [ 'description' => 'The name of the dedicated cluster.'."\n", 'type' => 'string', 'example' => 'testhostgroup', ], 'DedicatedHostIdForLog' => [ 'description' => 'The ID of the host on which the logger instance resides.'."\n", 'type' => 'string', 'example' => 'dh-bpxxxx', ], 'DedicatedHostIdForMaster' => [ 'description' => 'The ID of the host on which the primary instance resides.'."\n", 'type' => 'string', 'example' => 'dh-bpxxxx', ], 'DedicatedHostIdForSlave' => [ 'description' => 'The ID of the host on which the secondary instance resides.'."\n", 'type' => 'string', 'example' => 'dh-bpxxxx', ], 'DedicatedHostNameForLog' => [ 'description' => 'The name of the host on which the logger instance resides.'."\n", 'type' => 'string', 'example' => 'testlog', ], 'DedicatedHostNameForMaster' => [ 'description' => 'The name of the host on which the primary instance resides.'."\n", 'type' => 'string', 'example' => 'testmaster', ], 'DedicatedHostNameForSlave' => [ 'description' => 'The name of the host on which the secondary instance resides.'."\n", 'type' => 'string', 'example' => 'testslave', ], 'DedicatedHostZoneIdForLog' => [ 'description' => 'The zone ID of the host on which the logger instance resides.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou-b', ], 'DedicatedHostZoneIdForMaster' => [ 'description' => 'The zone ID of the host on which the primary instance resides.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou-c', ], 'DedicatedHostZoneIdForSlave' => [ 'description' => 'The zone ID of the host on which the secondary instance resides.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou-d', ], 'DeletionProtection' => [ 'description' => 'Indicates whether the release protection feature is enabled for the instance. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'false', ], 'DestroyTime' => [ 'description' => 'The time when the instance was destroyed. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2018-11-05T11:26:02Z', ], 'Engine' => [ 'description' => 'The database engine of the instance.'."\n", 'type' => 'string', 'example' => 'MySQL', ], 'EngineVersion' => [ 'description' => 'The database engine version.'."\n", 'type' => 'string', 'example' => '5.7', ], 'ExpireTime' => [ 'description' => 'The expiration time of the instance. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is displayed in UTC.'."\n" ."\n" .'> Pay-as-you-go instances never expire.'."\n", 'type' => 'string', 'example' => '2019-02-27T16:00:00Z', ], 'GeneralGroupName' => [ 'description' => 'The name of the dedicated cluster to which the instance belongs. This parameter is returned only when the instance is created in an ApsaraDB MyBase cluster that runs MySQL on Standard Edition.'."\n", 'type' => 'string', 'example' => 'TestGroup', ], 'GuardDBInstanceId' => [ 'description' => 'The ID of the disaster recovery instance. This parameter is returned only when the instance is a primary instance and has a disaster recovery instance attached.'."\n", 'type' => 'string', 'example' => 'rm-uf64zsuxxxxxxxxxx', ], 'InstanceNetworkType' => [ 'description' => 'The network type of the instance. Valid values:'."\n" ."\n" .'* **Classic**'."\n" .'* **VPC**'."\n", 'type' => 'string', 'example' => 'Classic', ], 'IoAccelerationEnabled' => [ 'description' => 'Indicates whether the I/O acceleration feature is enabled. Valid values:'."\n" ."\n" .'* 1: enabled'."\n" .'* 0: disabled'."\n", 'type' => 'string', 'example' => '0', ], 'LockMode' => [ 'description' => 'The lock mode of the instance. Valid values:'."\n" ."\n" .'* **Unlock**: The instance is not locked.'."\n" .'* **ManualLock**: The instance is manually locked.'."\n" .'* **LockByExpiration**: The instance is automatically locked due to instance expiration.'."\n" .'* **LockByRestoration**: The instance is automatically locked before the instance is rolled back.'."\n" .'* **LockByDiskQuota**: The instance is automatically locked due to exhausted storage capacity.'."\n" .'* **Released**: The instance is released. After an instance is released, the instance cannot be unlocked. You can only restore the backup data of the instance to a new instance. This process requires a long period of time.'."\n", 'type' => 'string', 'example' => 'Unlock', ], 'LockReason' => [ 'description' => 'The reason why the instance was locked.'."\n", 'type' => 'string', 'example' => 'instance_expired', ], 'MasterInstanceId' => [ 'description' => 'The ID of the primary instance. If this parameter is null, the instance is a primary instance.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5xxxxxxxxxx', ], 'MutriORsignle' => [ 'description' => 'Indicates whether the multi-zone deployment method is used for the instance. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n" ."\n" .'> If the multi-zone deployment method is used for the instance, the zone ID of the instance contains MAZ. Example: `cn-hangzhou-MAZ10(h,i)`.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'PayType' => [ 'description' => 'The billing method of the instance. Valid values:'."\n" ."\n" .'* **Postpaid**: pay-as-you-go'."\n" .'* **Prepaid**: subscription'."\n", 'type' => 'string', 'example' => 'Postpaid', ], 'ReadOnlyDBInstanceIds' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'ReadOnlyDBInstanceId' => [ 'description' => 'The IDs of the read-only instances. This parameter is returned only when the instance is a primary instance and has the read-only instances attached.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'DBInstanceId' => [ 'description' => 'The read-only instance ID.'."\n", 'type' => 'string', 'example' => 'rr-uf6wjk5xxxxxxx', ], ], ], ], ], ], 'RegionId' => [ 'description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], 'ResourceGroupId' => [ 'description' => 'The resource group ID.'."\n", 'type' => 'string', 'example' => 'rg-acfmyxxxxxxx', ], 'SwitchWeight' => [ 'description' => 'Indicates whether the instance supports weight-based switchovers for high availability. This parameter is returned only when the instance is created in an ApsaraDB MyBase cluster that runs MySQL on Standard Edition. Valid values:'."\n" ."\n" .'* **100**: The instance supports weight-based switchovers for high availability.'."\n" .'* **0**: The instance does not support weight-based switchovers for high availability.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'TempDBInstanceId' => [ 'description' => 'The ID of the temporary instance. This parameter is returned only when the instance is a primary instance and has a temporary instance attached.'."\n", 'type' => 'string', 'example' => 'rm-uf64zsuxxxxxxxxxx', ], 'Tips' => [ 'description' => 'The information about the exception that is detected on the instance. This parameter is returned only when the instance is created in an ApsaraDB MyBase cluster that runs MySQL on Standard Edition.'."\n", 'type' => 'string', 'example' => 'Run as expected.'."\n", ], 'TipsLevel' => [ 'description' => 'The severity of the exception that is detected on the instance. This parameter is returned only when the instance is created in an ApsaraDB MyBase cluster that runs MySQL on Standard Edition. Valid values:'."\n" ."\n" .'* **1**: The instance is normal.'."\n" .'* **2**: The specifications of the read-only instances do not match the specifications of the primary instance, and instance performance may be affected. You must adjust the specifications of these instances based on your business requirements.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'VSwitchId' => [ 'description' => 'The vSwitch ID.'."\n", 'type' => 'string', 'example' => 'vsw-uf6adz52c2pxxxxxxx', ], 'VpcCloudInstanceId' => [ 'description' => 'The ID of the instance. This parameter is returned only when the instance resides in a VPC.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5xxxxxxx', ], 'VpcId' => [ 'description' => 'The virtual private cloud (VPC) ID.'."\n", 'type' => 'string', 'example' => 'vpc-uf6f7l4fg90xxxxxxx', ], 'VpcName' => [ 'description' => 'The VPC name.'."\n", 'type' => 'string', 'example' => 'test-huadong', ], 'ZoneId' => [ 'description' => 'The zone ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou-a', ], 'BlueGreenDeploymentName' => [ 'type' => 'string', ], 'BlueInstanceName' => [ 'type' => 'string', ], 'GreenInstanceName' => [ 'type' => 'string', ], 'AutoRenewal' => [ 'type' => 'boolean', ], 'ColdDataEnabled' => [ 'description' => 'A reserved parameter.'."\n", 'type' => 'boolean', 'example' => 'false', ], 'IsAnalyticIns' => [ 'type' => 'string', ], ], ], ], ], ], 'NextToken' => [ 'description' => 'The token that is used to display the next page. If the returned entries are displayed on multiple pages, the next page can be displayed when you call this operation again with **NextToken** specified.'."\n", 'type' => 'string', 'example' => 'o7PORW5o2TJg**********', ], 'PageNumber' => [ 'description' => 'The page number of the returned page.'."\n" ."\n" .'> If you specify **MaxResults** or **NextToken**, only the value **1** is returned. You can ignore the value 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageRecordCount' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', ], 'TotalRecordCount' => [ 'description' => 'The total number of entries returned.'."\n" ."\n" .'> If you specify **MaxResults** or **NextToken**, only the number of entries on the current page is returned. You can ignore the number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Invalid.NextToken', 'errorMessage' => 'The parameter NextToken is invalid.', ], [ 'errorCode' => 'InvalidDBInstanceType.ValueNotSupport', 'errorMessage' => 'The specified parameter DBInstanceType is not valid.', ], [ 'errorCode' => 'InvalidParameter.OwnerAccount', 'errorMessage' => 'The specified parameter OwnerAccount is not valid.', ], [ 'errorCode' => 'TimeoutRetryLater', 'errorMessage' => 'Timeout, Please retry later.', ], [ 'errorCode' => 'InvalidExpired.Format', 'errorMessage' => 'The instance expiration status parameter is incorrect.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'Abs.ImageNotFound', 'errorMessage' => 'The specified Image is disabled or is deleted.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Items\\": {\\n \\"DBInstance\\": [\\n {\\n \\"BpeEnabled\\": \\"0\\",\\n \\"BurstingEnabled\\": false,\\n \\"Category\\": \\"Basic\\",\\n \\"IsAnalyticReadOnlyIns\\": false,\\n \\"ConnectionMode\\": \\"Standard\\",\\n \\"ConnectionString\\": \\"rm-uf6wjk5****.mysql.rds.aliyuncs.com\\",\\n \\"CreateTime\\": \\"2018-11-05T11:26:02Z\\",\\n \\"DBInstanceCPU\\": \\"2\\",\\n \\"DBInstanceClass\\": \\"rds.mys2.small\\",\\n \\"DBInstanceDescription\\": \\"testdb\\",\\n \\"DBInstanceId\\": \\"rm-uf6wjk5****\\",\\n \\"DBInstanceMemory\\": 4096,\\n \\"DBInstanceNetType\\": \\"Internet\\",\\n \\"DBInstanceStatus\\": \\"Running\\",\\n \\"DBInstanceStorageType\\": \\"ModuleList.4.ModuleCode\\",\\n \\"DBInstanceType\\": \\"Primary\\",\\n \\"DedicatedHostGroupId\\": \\"dhg-7a9****\\",\\n \\"DedicatedHostGroupName\\": \\"testhostgroup\\",\\n \\"DedicatedHostIdForLog\\": \\"dh-bp****\\",\\n \\"DedicatedHostIdForMaster\\": \\"dh-bp****\\",\\n \\"DedicatedHostIdForSlave\\": \\"dh-bp****\\",\\n \\"DedicatedHostNameForLog\\": \\"testlog\\",\\n \\"DedicatedHostNameForMaster\\": \\"testmaster\\",\\n \\"DedicatedHostNameForSlave\\": \\"testslave\\",\\n \\"DedicatedHostZoneIdForLog\\": \\"cn-hangzhou-b\\",\\n \\"DedicatedHostZoneIdForMaster\\": \\"cn-hangzhou-c\\",\\n \\"DedicatedHostZoneIdForSlave\\": \\"cn-hangzhou-d\\",\\n \\"DeletionProtection\\": false,\\n \\"DestroyTime\\": \\"2018-11-05T11:26:02Z\\",\\n \\"Engine\\": \\"MySQL\\",\\n \\"EngineVersion\\": \\"5.7\\",\\n \\"ExpireTime\\": \\"2019-02-27T16:00:00Z\\",\\n \\"GeneralGroupName\\": \\"TestGroup\\",\\n \\"GuardDBInstanceId\\": \\"rm-uf64zsu****\\",\\n \\"InstanceNetworkType\\": \\"Classic\\",\\n \\"IoAccelerationEnabled\\": \\"0\\",\\n \\"LockMode\\": \\"Unlock\\",\\n \\"LockReason\\": \\"instance_expired\\",\\n \\"MasterInstanceId\\": \\"rm-uf6wjk5****\\",\\n \\"MutriORsignle\\": true,\\n \\"PayType\\": \\"Postpaid\\",\\n \\"ReadOnlyDBInstanceIds\\": {\\n \\"ReadOnlyDBInstanceId\\": [\\n {\\n \\"DBInstanceId\\": \\"rr-uf6wjk5****\\"\\n }\\n ]\\n },\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ResourceGroupId\\": \\"rg-acfmy****\\",\\n \\"SwitchWeight\\": 100,\\n \\"TempDBInstanceId\\": \\"rm-uf64zsu****\\",\\n \\"Tips\\": \\"normal\\",\\n \\"TipsLevel\\": 1,\\n \\"VSwitchId\\": \\"vsw-uf6adz52c2p****\\",\\n \\"VpcCloudInstanceId\\": \\"rm-uf6wjk5****\\",\\n \\"VpcId\\": \\"vpc-uf6f7l4fg90****\\",\\n \\"VpcName\\": \\"test-huadong\\",\\n \\"ZoneId\\": \\"cn-hangzhou-a\\",\\n \\"BlueGreenDeploymentName\\": \\"test\\",\\n \\"BlueInstanceName\\": \\"test\\",\\n \\"GreenInstanceName\\": \\"test\\",\\n \\"AutoRenewal\\": false,\\n \\"ColdDataEnabled\\": false,\\n \\"IsAnalyticIns\\": \\"\\"\\n }\\n ]\\n },\\n \\"NextToken\\": \\"o7PORW5o2TJg****\\",\\n \\"PageNumber\\": 1,\\n \\"PageRecordCount\\": 10,\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"TotalRecordCount\\": 100\\n}","errorExample":""},{"type":"xml","example":"\\n 1\\n 1\\n A436D75C-30B0-1F34-8544-4B46F4407CC1\\n o7PORW5owHNg**********\\n 1\\n \\n \\n 10.0\\n cn-hangzhou-h\\n Running\\n rg-acfmyiu********\\n Intranet\\n pg.n2.small.2c\\n 2021-02-02T09:14:48Z\\n vsw-bp10aqj6o4lcl********\\n 0\\n Primary\\n Prepaid\\n Unlock\\n false\\n false\\n VPC\\n 1\\n vpc-bp1opxu1zkhn0********\\n pgm-bp10re7n********\\n Standard\\n \\n \\n pgm-bp10re7n********\\n cn-hangzhou\\n pgm-bp10re7n**************.pg.rds.aliyuncs.com\\n 2021-02-03T09:14:48Z\\n PostgreSQL\\n \\n \\n","errorExample":""}]', 'title' => 'DescribeDBInstances', 'description' => '### Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" .'* MariaDB'."\n", 'requestParamsDescription' => 'You can use one of the following methods to check the response:'."\n" ."\n" .'* Method 1: Use **MaxResults** to specify the number of entries per page. Then, use **NextToken** to specify the token that is used to display the next page. **NextToken** is set to the value that is returned from the most recent call of the **DescribeDBInstances** operation for **NextToken**.'."\n" ."\n" .'> The first time you call the DescribeDBInstances operation to perform a paged query, you need only to specify **MaxResults**. In this case, the operation returns the data of the first page and the value of **NextToken**.'."\n" ."\n" .'* Method 2: Use **PageSize** to specify the number of entries per page. Then, use **PageNumber** to display the next page.'."\n" ."\n" .'> You can use only one of the preceding methods. If a large number of entries are returned, we recommend that you use Method 1 to increase the query speed.'."\n", 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ListClasses' => [ 'summary' => 'Queries the specification details of an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxx', ], ], [ 'name' => 'CommodityCode', 'in' => 'query', 'schema' => [ 'description' => 'The commodity code of the instances.'."\n" ."\n" .'* **bards_intl**: The instances are pay-as-you-go primary instances.'."\n" .'* **rds_intl**: The instances are subscription primary instances.'."\n" .'* **rords_intl**: The instances are pay-as-you-go read-only instances.'."\n" .'* **rds_rordspre_public_intl**: The instances are subscription read-only instances.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'bards_intl', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n" ."\n" .'> If you set the **CommodityCode** parameter to the commodity code of read-only instances, you must specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rm-uf6wjk5xxxxxxx', ], ], [ 'name' => 'OrderType', 'in' => 'query', 'schema' => [ 'description' => 'The type of order that you want to query. Valid values:'."\n" ."\n" .'* **BUY**: specifies the query orders that are used to purchase instances.'."\n" .'* **UPGRADE**: specifies the query orders that are used to change the specifications of instances.'."\n" .'* **RENEW**: specifies the query orders that are used to renew instances.'."\n" .'* **CONVERT**: specifies the query orders that are used to change the billing methods of instances.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'BUY', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the DescribeRegions operation to query the most recent region list.'."\n" ."\n" .'> If you are using an Alibaba Cloud account on the International site (alibabacloud.com), you must specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'Engine', 'in' => 'query', 'schema' => [ 'description' => 'The database engine of the instance. Valid values:'."\n" ."\n" .'* **MySQL**'."\n" .'* **SQLServer**'."\n" .'* **PostgreSQL**'."\n" .'* **MariaDB**'."\n", 'type' => 'string', 'required' => false, 'example' => 'MySQL', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Items' => [ 'description' => 'The list of instance specifications.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'ClassCode' => [ 'description' => 'The code of the instance type. For more information, see [Primary ApsaraDB RDS instance types](~~26312~~) and [Read-only ApsaraDB RDS instance types](~~145759~~).'."\n", 'type' => 'string', 'example' => 'mysql.n1.micro.1', ], 'ClassGroup' => [ 'description' => 'The instance family. For more information, see [Overview of instance families](~~57184~~).'."\n", 'type' => 'string', 'example' => 'General'."\n", ], 'Cpu' => [ 'description' => 'The number of CPU cores that are supported by the instance type. Unit: cores.'."\n", 'type' => 'string', 'example' => '1', ], 'EncryptedMemory' => [ 'description' => 'The size of the encrypted memory that is supported by the security-enhanced instance type. Unit: GB.'."\n", 'type' => 'string', 'example' => '4', ], 'InstructionSetArch' => [ 'description' => 'The architecture of the instance type. Valid values:'."\n" ."\n" .'* If the architecture of the instance type is **x86**, an empty string is returned by default.'."\n" .'* If the architecture of the instance type is **ARM**, **arm** is returned.'."\n", 'type' => 'string', 'example' => 'arm', ], 'MaxConnections' => [ 'description' => 'The maximum number of connections that are supported by the instance type. Unit: connections.'."\n", 'type' => 'string', 'example' => '2000', ], 'MaxIOMBPS' => [ 'description' => 'The maximum I/O bandwidth that is supported by the instance type. Unit: Mbit/s.'."\n", 'type' => 'string', 'example' => '1024Mbps', ], 'MaxIOPS' => [ 'description' => 'The maximum input/output operations per second (IOPS) that is supported by the instance type. Unit: operations per second.'."\n", 'type' => 'string', 'example' => '10000', ], 'MemoryClass' => [ 'description' => 'The memory size that is supported by the instance type. Unit: GB.'."\n", 'type' => 'string', 'example' => '1 GB (RDS Basic Edition)'."\n", ], 'ReferencePrice' => [ 'description' => 'The fee that you must pay for the instance type.'."\n" ."\n" .'* Unit: cents (USD).'."\n" ."\n" .'> * If you set **CommodityCode** to a value that indicates the pay-as-you-go billing method, the ReferencePrice parameter specifies the hourly fee that you must pay.'."\n" .'> * If you set **CommodityCode** to a value that indicates the subscription billing method, the ReferencePrice parameter specifies the monthly fee that you must pay.', 'type' => 'string', 'example' => '2500', ], 'category' => [ 'description' => 'The RDS edition of the instance. Valid values:'."\n" ."\n" .'* Regular instance'."\n" ."\n" .' * **Basic**: RDS Basic Edition'."\n" .' * **HighAvailability**: RDS High-availability Edition'."\n" .' * **cluster**: RDS Cluster Edition for ApsaraDB RDS for MySQL or PostgreSQL'."\n" .' * **AlwaysOn**: RDS Cluster Edition for ApsaraDB RDS for SQL Server'."\n" .' * **Finance**: RDS Basic Edition for serverless instances'."\n" ."\n" .'* Serverless instance'."\n" ."\n" .' * **serverless_basic**: RDS Basic Edition for serverless instances. This edition is available only for instances that run MySQL and PostgreSQL.'."\n" .' * **serverless_standard**: RDS High-availability Edition for serverless instances. This edition is available only for instances that run MySQL and PostgreSQL.'."\n" .' * **serverless_ha**: RDS High-availability Edition for serverless instances. This edition is available only for instances that run SQL Server.'."\n", 'type' => 'string', 'example' => 'Basic', ], 'storageType' => [ 'description' => 'The storage type of the instance.'."\n", 'type' => 'string', 'example' => 'cloud_essd', ], ], ], ], 'RegionId' => [ 'description' => 'The ID of the region.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'CF8D35BF-263D-4F7B-883A-1163B79A9EC6', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidSecurityIPList.Malformed', 'errorMessage' => 'The specified parameter SecurityIPList is not valid.', ], [ 'errorCode' => 'InvalidSecurityIPList.Duplicate', 'errorMessage' => 'The Security IP address is not in the available range or occupied.', ], [ 'errorCode' => 'InvalidCommodityCode.Malformed', 'errorMessage' => 'The commodity code is invalid.', ], [ 'errorCode' => 'ArticleNotFound', 'errorMessage' => 'Article not found', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'Forbidden.Authentication', 'errorMessage' => 'The operation is forbidden by Aliyun Realname Authentication System.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'GetCommodity.Failed', 'errorMessage' => 'Get commodity failed.', ], [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'Invalid DBInstanceId NotFound.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Items\\": [\\n {\\n \\"ClassCode\\": \\"mysql.n1.micro.1\\",\\n \\"ClassGroup\\": \\"general-purpose\\",\\n \\"Cpu\\": \\"1\\",\\n \\"EncryptedMemory\\": \\"4\\",\\n \\"InstructionSetArch\\": \\"arm\\",\\n \\"MaxConnections\\": \\"2000\\",\\n \\"MaxIOMBPS\\": \\"1024Mbps\\",\\n \\"MaxIOPS\\": \\"10000\\",\\n \\"MemoryClass\\": \\"1GB\\",\\n \\"ReferencePrice\\": \\"2500\\",\\n \\"category\\": \\"Basic\\",\\n \\"storageType\\": \\"cloud_essd\\"\\n }\\n ],\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"RequestId\\": \\"CF8D35BF-263D-4F7B-883A-1163B79A9EC6\\"\\n}","errorExample":""},{"type":"xml","example":"\\nCF8D35BF-263D-4F7B-883A-1163B79A9EC6\\n\\n 1024Mbps\\n mysql.n2.medium.1\\n 4000\\n 通用型\\n 2 \\n 4GB（单机基础版）\\n 32.6\\n 10000\\n\\n\\n 1024Mbps\\n mysql.n1.micro.1\\n 2000\\n 通用型\\n 1 \\n 1GB（单机基础版）\\n 5.2\\n 10000\\n\\n","errorExample":""}]', 'title' => 'ListClasses', 'description' => '### Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" .'* MariaDB'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeDBInstancesByExpireTime' => [ 'summary' => 'Queries the information about an ApsaraDB RDS instance based on the remaining subscription duration of an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'proxyId', 'in' => 'query', 'schema' => [ 'description' => 'A deprecated parameter. You do not need to configure this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'None'."\n", ], ], [ 'name' => 'ExpirePeriod', 'in' => 'query', 'schema' => [ 'description' => 'The number of remaining days for which the instances are available. Valid values: **0 to 180**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '180', 'minimum' => '-15', 'example' => '180', ], ], [ 'name' => 'Expired', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to query instances that have expired. Valid values:'."\n" ."\n" .'* **True**: queries instances that have expired.'."\n" .'* **False**: does not query instances that have expired.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'True', 'default' => 'false', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Valid values: **1 to 100**.'."\n" ."\n" .'Default value: **30**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'example' => '30', 'default' => '30', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Valid values: any **non-zero** positive integer.'."\n" ."\n" .'Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', ], ], [ 'name' => 'Tags', 'in' => 'query', 'schema' => [ 'description' => 'The tag that is added to the instance. Each tag is a key-value pair that consists of two parts: TagKey and TagValue. You can specify a maximum of five tags in the following format for each request: `{"key1":"value1","key2":"value2"...}`.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"key1":"value1"} ', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The resource group ID. You can call the DescribeDBInstanceAttribute operation to obtain the resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Items' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'DBInstanceExpireTime' => [ 'description' => 'The details of the instances.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'DBInstanceDescription' => [ 'description' => 'The description of the instance.'."\n", 'type' => 'string', 'example' => 'Test database'."\n", ], 'DBInstanceId' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5xxxxxxx', ], 'DBInstanceStatus' => [ 'description' => 'The status of the instance. For more information, see [Instance state table](~~26315~~).'."\n", 'type' => 'string', 'example' => 'Running', ], 'ExpireTime' => [ 'description' => 'The expiration time of the instance. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is displayed in UTC.'."\n" ."\n" .'> : Pay-as-you-go instances never expire.'."\n", 'type' => 'string', 'example' => '2019-03-27T16:00:00Z', ], 'LockMode' => [ 'description' => 'The lock mode of the instance. Valid values:'."\n" ."\n" .'* **Unlock**: The instance is not locked.'."\n" .'* **ManualLock**: The instance is manually locked.'."\n" .'* **LockByExpiration**: The instance is automatically locked after it expires.'."\n" .'* **LockByRestoration**: The instance is automatically locked before it is rolled back.'."\n" .'* **LockByDiskQuota**: The instance is automatically locked after its storage capacity is exhausted.'."\n" .'* **LockReadInstanceByDiskQuota**: The instance is a read-only instance and is automatically locked after its storage capacity is exhausted.'."\n", 'type' => 'string', 'example' => 'Unlock', ], 'PayType' => [ 'description' => 'The billing method of the instance. Valid values:'."\n" ."\n" .'* **Postpaid**: pay-as-you-go.'."\n" .'* **Prepaid**: subscription.'."\n", 'type' => 'string', 'example' => 'Prepaid', ], ], ], ], ], ], 'PageNumber' => [ 'description' => 'The page number of the returned page. Valid values: any **non-zero** positive integer.'."\n" ."\n" .'Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageRecordCount' => [ 'description' => 'The number of instances returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', ], 'TotalRecordCount' => [ 'description' => 'The total number of returned entries.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Items\\": {\\n \\"DBInstanceExpireTime\\": [\\n {\\n \\"DBInstanceDescription\\": \\"testInstance\\",\\n \\"DBInstanceId\\": \\"rm-uf6wjk5xxxxxxx\\",\\n \\"DBInstanceStatus\\": \\"Running\\",\\n \\"ExpireTime\\": \\"2019-03-27T16:00:00Z\\",\\n \\"LockMode\\": \\"Unlock\\",\\n \\"PayType\\": \\"Prepaid\\"\\n }\\n ]\\n },\\n \\"PageNumber\\": 1,\\n \\"PageRecordCount\\": 2,\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"TotalRecordCount\\": 200\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n 2\\n 1AD222E9-E606-4A42-BF6D-8A4442913CEF\\n 1\\n \\n \\n Running\\n rm-uf6wjk5xxxxxxx\\n Prepaid\\n Unlock\\n 2019-03-27T16:00:00Z\\n 测试数据库\\n \\n \\n","errorExample":""}]', 'title' => 'DescribeDBInstancesByExpireTime', 'description' => '### Supported database engines'."\n" ."\n" .'* RDS MySQL'."\n" .'* RDS PostgreSQL'."\n" .'* RDS SQL Server'."\n" .'* RDS MariaDB'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeRegions' => [ 'summary' => 'Queries the details of all regions and zones for ApsaraDB RDS. The regions that are no longer supported are also queried. Exercise caution when you call this operation.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'AcceptLanguage', 'in' => 'query', 'schema' => [ 'description' => 'The language that is used for the return value of the **LocalName** parameter. Valid values:'."\n" ."\n" .'* **zh-CN**: Chinese'."\n" .'* **en-US**: English'."\n" ."\n" .'Default value: **en-US**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'en-US', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Regions' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'RDSRegion' => [ 'description' => 'The available regions and zones.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'LocalName' => [ 'description' => 'The region name. The return value of this parameter is in the language that is specified by the **AcceptLanguage** parameter. For example, if the value of the RegionId parameter in the response is cn-hangzhou, the following values are returned for the LocalName parameter:'."\n" ."\n" .'* If the value of the **AcceptLanguage** parameter is **zh-CN**, the value 1()is returned for the LocalName parameter.'."\n" .'* If the value of the **AcceptLanguage** parameter is **en-US**, the value China (Hangzhou) is returned for the LocalName parameter.', 'type' => 'string', 'example' => 'China (Hangzhou)', ], 'RegionEndpoint' => [ 'description' => 'The endpoint that is used to connect to Alibaba Cloud services in the region. For more information, see [Endpoints](~~610370~~).'."\n", 'type' => 'string', 'example' => 'rds.aliyuncs.com', ], 'RegionId' => [ 'description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], 'ZoneId' => [ 'description' => 'The zone ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou-h', ], 'ZoneName' => [ 'description' => 'The zone name. The return value of this parameter is in the language that is specified by the **AcceptLanguage** parameter. For example, if the value of the ZoneId parameter in the response is cn-hangzhou-j, the following values are returned for the ZoneName parameter:'."\n" ."\n" .'* If the value of the **AcceptLanguage** parameter is **zh-CN**, the value J is returned for the ZoneName parameter.'."\n" .'* If the value of the **AcceptLanguage** parameter is **en-US**, the value Hangzhou Zone J is returned for the ZoneName parameter.'."\n", 'type' => 'string', 'example' => 'Hangzhou Zone H', ], ], ], ], ], ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidAcceptLanguage.NotFound', 'errorMessage' => 'Only Chinese (zh-CN) and English (en-US) are allowed.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Regions\\": {\\n \\"RDSRegion\\": [\\n {\\n \\"LocalName\\": \\"China (Hangzhou)\\",\\n \\"RegionEndpoint\\": \\"rds.aliyuncs.com\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ZoneId\\": \\"cn-hangzhou-j\\",\\n \\"ZoneName\\": \\"Hangzhou Zone J\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"7463B73D-35CC-4D19-A010-6B8D65D242EF\\",\\n \\"HostId\\": \\"rds.aliyuncs.com\\",\\n \\"Code\\": \\"UnsupportedOperation\\",\\n \\"Message\\": \\"The specified action is not supported.\\"\\n}"},{"type":"xml","example":"\\n1CE1DC20-7EFC-464F-9583-0AB8915C5697\\n\\n \\n Hangzhou Zone H\\n cn-hangzhou-h\\n cn-hangzhou\\n China (Hangzhou)\\n rds.aliyuncs.com\\n \\n \\n East China 1 MZone10 H+I\\n cn-hangzhou-MAZ10(h,i)\\n cn-hangzhou\\n China (Hangzhou)\\n rds.aliyuncs.com\\n \\n \\n East China 1 MZone8 F+G\\n cn-hangzhou-MAZ8(f,g)\\n cn-hangzhou\\n China (Hangzhou)\\n rds.aliyuncs.com\\n \\n\\n","errorExample":""}]', 'title' => 'DescribeRegions', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" .'* MariaDB'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'CheckInstanceExist' => [ 'summary' => 'You can call the CheckInstanceExist operation to query whether an ApsaraDB RDS instance exists.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'rm-uf6wjk5****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'IsExistInstance' => [ 'description' => 'Indicates whether the instance exists. Valid values:'."\n" .'- **true**: The instance exists.'."\n" .'- **false**: The instance does not exist.', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '11439B36-F703-49EB-8656-D3C87BE28B57', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'Invalid DBInstanceId NotFound.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"IsExistInstance\\": true,\\n \\"RequestId\\": \\"11439B36-F703-49EB-8656-D3C87BE28B57\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 11439B36-F703-49EB-8656-D3C87BE28B57\\n true\\n","errorExample":""}]', 'title' => 'Query whether an instance exists', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeHADiagnoseConfig' => [ 'summary' => 'Queries the availability check method of an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5xxxxxxxxxx ', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '06B220E2-EAC5-4DBE-A1FC-1B62DB6A****', ], 'TcpConnectionType' => [ 'description' => 'The availability check method of the instance. Valid values:'."\n" ."\n" .'* **LONG**: Alibaba Cloud uses persistent connections to check the availability of the instance.'."\n" .'* **SHORT**: Alibaba Cloud uses short-lived connections to check the availability of the instance.'."\n", 'type' => 'string', 'example' => 'LONG', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"06B220E2-EAC5-4DBE-A1FC-1B62DB6A****\\",\\n \\"TcpConnectionType\\": \\"LONG\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 06B220E2-EAC5-4DBE-A1FC-1B62DB6A4455\\n LONG\\n","errorExample":""}]', 'title' => 'DescribeHADiagnoseConfig', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" .'* MariaDB'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'[What is availability detection?](~~207467~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeAnalyticdbByPrimaryDBInstance' => [ 'summary' => 'Queries the number of analytic instances that are associated with an ApsaraDB RDS for MySQL instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5*******', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'AnalyticDBCount' => [ 'description' => 'The number of associated analytic instances.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '77862BFF-ED59-552A-A2E8-692FEAFC9527', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"AnalyticDBCount\\": 0,\\n \\"RequestId\\": \\"77862BFF-ED59-552A-A2E8-692FEAFC9527\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 77862BFF-ED59-552A-A2E8-692FEAFC9527\\n 0\\n","errorExample":""}]', 'title' => 'DescribeAnalyticdbByPrimaryDBInstance', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'MySQL'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'[Create and view an analytic instance](~~2950002~~)', ], 'CheckCloudResourceAuthorized' => [ 'summary' => 'Checks permissions that are granted on an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'rm-t4n7j9eb52y7c1960', ], ], [ 'name' => 'TargetRegionId', 'in' => 'query', 'schema' => [ 'description' => 'The destination region ID. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => false, 'example' => 'us-east-1', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy**********', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'AuthorizationState' => [ 'description' => 'The authorization status. Valid values:'."\n" ."\n" .'* **1**: authorized'."\n" .'* **0**: not authorized'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '8B993DA9-5272-5414-94E3-4CA8BA0146C2', ], 'RoleArn' => [ 'description' => 'The Alibaba Cloud Resource Name (ARN) of the RAM role. A RAM role is a virtual identity that you can create within your Alibaba Cloud account. For more information, see [RAM role overview](~~93689~~).'."\n", 'type' => 'string', 'example' => 'acs:ram::1406926****:role/aliyunrdsinstanceencryptiondefaultrole', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidParameter.ByokInsnameAndRegionAllEmpty', 'errorMessage' => 'The insName and targetRegionId can\'t be all empty.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"AuthorizationState\\": 1,\\n \\"RequestId\\": \\"8B993DA9-5272-5414-94E3-4CA8BA0146C2\\",\\n \\"RoleArn\\": \\"acs:ram::1406926****:role/aliyunrdsinstanceencryptiondefaultrole\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 1\\n 525DC837-1677-5D76-94F2-80DD30F109F0\\n acs:ram::1204700685511859:role/aliyunrdsinstanceencryptiondefaultrole\\n","errorExample":""}]', 'title' => 'CheckCloudResourceAuthorized', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" .'* MariaDB'."\n", ], 'ReleaseInstanceConnection' => [ 'summary' => 'Releases the public endpoint of an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'delete', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5xxxxxxx', ], ], [ 'name' => 'CurrentConnectionString', 'in' => 'query', 'schema' => [ 'description' => 'The public endpoint of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5xxxx.mysql.rds.aliyuncs.com', ], ], [ 'name' => 'InstanceNetworkType', 'in' => 'query', 'schema' => [ 'description' => 'The network type of the instance. Valid values:'."\n" ."\n" .'* **0**: virtual private cloud (VPC)'."\n" .'* **1**: classic network'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '65BDA532-28AF-4122-AA39-B382721EEE64', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], [ 'errorCode' => 'UnsupportedByBlueGreenDeployment', 'errorMessage' => 'Operation prohibited due to blue green deployment.', ], ], [ [ 'errorCode' => 'Endpoint.NotFound', 'errorMessage' => 'Specified endpoint is not existed.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"65BDA532-28AF-4122-AA39-B382721EEE64\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 65BDA532-28AF-4122-AA39-B382721EEE64\\r\\n","errorExample":""}]', 'title' => 'ReleaseInstanceConnection', 'description' => '### Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" .'* MariaDB'."\n" ."\n" .'### References'."\n" ."\n" .'* [Release the public endpoint of an ApsaraDB RDS for MySQL instance](~~26128~~)'."\n" .'* [Release the public endpoint of an ApsaraDB RDS for PostgreSQL instance](~~97738~~)'."\n" .'* [Release the public endpoint of an ApsaraDB RDS for SQL Server instance](~~97736~~)'."\n" .'* [Release the public endpoint of an ApsaraDB RDS for MariaDB instance](~~97740~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeDBInstanceDetail' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request.'."\n" ."\n" .'> You can use the client to generate the value, but you must ensure that it is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCziJZNwH****', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the instance. You can call the [DescribeDBInstances](~~26232~~) operation to query the ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-bp6wjk5xxxxxxxxxx', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the instance. You can call the [DescribeDBInstances](~~26232~~) operation to query the ID of the instance.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'rm-bp6wjk5xxxxxxxxxx', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy*****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'ActivationState' => [ 'description' => 'Indicates whether the instance is in the active state.'."\n", 'type' => 'string', 'example' => 'Invalid', ], 'DBInstanceId' => [ 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'rm-bp6wjk5xxxxxxxxxx', ], 'LicenseType' => [ 'description' => 'The type of the license.'."\n", 'type' => 'string', 'example' => 'Normal', ], 'RegionId' => [ 'description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '06B220E2-EAC5-4DBE-A1FC-1B62DB6A****', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidEngine.NotSupported', 'errorMessage' => 'Current engine does not support this api.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"ActivationState\\": \\"Invalid\\",\\n \\"DBInstanceId\\": \\"rm-bp6wjk5xxxxxxxxxx\\",\\n \\"LicenseType\\": \\"Normal\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"RequestId\\": \\"06B220E2-EAC5-4DBE-A1FC-1B62DB6A****\\"\\n}","errorExample":""},{"type":"xml","example":"06B220E2-EAC5-4DBE-A1FC-1B62DB6A****\\nrm-uf6wjk5xxxxxxxxxx\\n\\ncn-hangzhou\\n","errorExample":""}]', 'title' => 'Query the details of an instance', 'summary' => 'You can call the DescribeDBInstanceDetail operation to query the details of an instance.', 'description' => 'This operation is phased out.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeDBInstancesByPerformance' => [ 'summary' => 'You can call the DescribeDBInstancePerformance operation to query the performance of instances.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCzxxxxxx', ], ], [ 'name' => 'proxyId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the proxy mode.'."\n", 'type' => 'string', 'required' => false, 'example' => 'API', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rm-uf6wjk5xxxxxx', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Valid values: **5** to **100**.'."\n" ."\n" .'Default value: **30**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '30', 'default' => '30', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Valid values: any non-zero positive integer.'."\n" ."\n" .'Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '0', 'example' => '1', 'default' => '1', ], ], [ 'name' => 'SortMethod', 'in' => 'query', 'schema' => [ 'description' => 'The sorting method.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ASC', 'default' => 'ASC', ], ], [ 'name' => 'SortKey', 'in' => 'query', 'schema' => [ 'description' => 'The sorting basis.'."\n", 'type' => 'string', 'required' => false, 'example' => 'CPU_Usage', 'default' => 'CPUUsage', ], ], [ 'name' => 'Tags', 'in' => 'query', 'schema' => [ 'description' => 'The tags that are added to the instances. Each tag is a key-value pair that consists of two parts: TagKey and TagValue. Format: `{"key1":"value1"}`.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"key1":"value1"}', ], ], [ 'name' => 'Tag.1.key', 'in' => 'query', 'schema' => [ 'description' => 'The key of tag 1 that is added to the instances.'."\n", 'type' => 'string', 'required' => false, 'example' => 'key1', ], ], [ 'name' => 'Tag.2.key', 'in' => 'query', 'schema' => [ 'description' => 'The key of tag 2 that is added to the instances.'."\n", 'type' => 'string', 'required' => false, 'example' => 'key2', ], ], [ 'name' => 'Tag.3.key', 'in' => 'query', 'schema' => [ 'description' => 'The key of tag 3 that is added to the instances.'."\n", 'type' => 'string', 'required' => false, 'example' => 'key3', ], ], [ 'name' => 'Tag.4.key', 'in' => 'query', 'schema' => [ 'description' => 'The key of tag 4 that is added to the instances.'."\n", 'type' => 'string', 'required' => false, 'example' => 'key4', ], ], [ 'name' => 'Tag.5.key', 'in' => 'query', 'schema' => [ 'description' => 'The key of tag 5 that is added to the instances.'."\n", 'type' => 'string', 'required' => false, 'example' => 'key5', ], ], [ 'name' => 'Tag.1.value', 'in' => 'query', 'schema' => [ 'description' => 'The value of tag 1 that is added to the instances.'."\n", 'type' => 'string', 'required' => false, 'example' => 'value1', ], ], [ 'name' => 'Tag.2.value', 'in' => 'query', 'schema' => [ 'description' => 'The value of tag 2 that is added to the instances.'."\n", 'type' => 'string', 'required' => false, 'example' => 'value2', ], ], [ 'name' => 'Tag.3.value', 'in' => 'query', 'schema' => [ 'description' => 'The value of tag 3 that is added to the instances.'."\n", 'type' => 'string', 'required' => false, 'example' => 'value3', ], ], [ 'name' => 'Tag.4.value', 'in' => 'query', 'schema' => [ 'description' => 'The value of tag 4 that is added to the instances.'."\n", 'type' => 'string', 'required' => false, 'example' => 'value4', ], ], [ 'name' => 'Tag.5.value', 'in' => 'query', 'schema' => [ 'description' => 'The value of tag 5 that is added to the instances.'."\n", 'type' => 'string', 'required' => false, 'example' => 'value5', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the instance. You can call the [DescribeRegions](~~26243~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy*****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Items' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'DBInstancePerformance' => [ 'description' => 'The details about the instance.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details about the instance.'."\n", 'type' => 'object', 'properties' => [ 'CPUUsage' => [ 'description' => 'The CPU utilization of the instance in percentage.'."\n", 'type' => 'string', 'example' => '0.70', ], 'DBInstanceDescription' => [ 'description' => 'The name of the instance.'."\n", 'type' => 'string', 'example' => 'DatabaseTest', ], 'DBInstanceId' => [ 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5xxxxxx', ], 'DiskUsage' => [ 'description' => 'The disk usage of the instance in percentage.'."\n", 'type' => 'string', 'example' => '14.56', ], 'IOPSUsage' => [ 'description' => 'The IOPS usage of the instance in percentage.'."\n", 'type' => 'string', 'example' => '0.15', ], 'SessionUsage' => [ 'description' => 'The number of sessions.'."\n", 'type' => 'string', 'example' => '0.10', ], ], ], ], ], ], 'PageNumber' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageRecordCount' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '28', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '23907437-79B9-411A-9EE6-75A8F0F1C619', ], 'TotalRecordCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '28', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Items\\": {\\n \\"DBInstancePerformance\\": [\\n {\\n \\"CPUUsage\\": \\"0.70\\",\\n \\"DBInstanceDescription\\": \\"DatabaseTest\\",\\n \\"DBInstanceId\\": \\"rm-uf6wjk5xxxxxx\\",\\n \\"DiskUsage\\": \\"14.56\\",\\n \\"IOPSUsage\\": \\"0.15\\",\\n \\"SessionUsage\\": \\"0.10\\"\\n }\\n ]\\n },\\n \\"PageNumber\\": 1,\\n \\"PageRecordCount\\": 28,\\n \\"RequestId\\": \\"23907437-79B9-411A-9EE6-75A8F0F1C619\\",\\n \\"TotalRecordCount\\": 28\\n}","errorExample":""},{"type":"xml","example":"28\\n28\\n23907437-79B9-411A-9EE6-75A8F0F1C619\\n1\\n\\n \\n 0.15\\n rm-uf6wjk5xxxxxx\\n 0.70\\n 14.56\\n 0.10\\n DatabaseTest\\n \\n","errorExample":""}]', 'title' => 'Query instances base on performance', 'description' => 'This operation is phased out.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeDBInstancesForClone' => [ 'summary' => 'Queries a list of instances.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => true, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxxxxx', ], ], [ 'name' => 'proxyId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the proxy mode.'."\n", 'type' => 'string', 'required' => false, 'example' => 'API ', ], ], [ 'name' => 'Engine', 'in' => 'query', 'schema' => [ 'description' => 'The database engine of the instance. Valid values:'."\n" ."\n" .'* MySQL'."\n" .'* SQLServer'."\n" .'* PostgreSQL'."\n" .'* PPAS'."\n" .'* MariaDB'."\n" ."\n" .'By default, this operation queries the instances that run any of the supported database engine types.'."\n", 'type' => 'string', 'required' => false, 'example' => 'MySQL', ], ], [ 'name' => 'ZoneId', 'in' => 'query', 'schema' => [ 'description' => 'The zone ID of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-h', ], ], [ 'name' => 'DBInstanceStatus', 'in' => 'query', 'schema' => [ 'description' => 'The status of the instance. For more information, see [Instance state table](~~26315~~).'."\n", 'type' => 'string', 'required' => false, 'example' => 'Running', ], ], [ 'name' => 'Expired', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether the instance expires. Valid values:'."\n" ."\n" .'* **True**: queries the instances that have expired.'."\n" .'* **False**: does not query instances that have expired.'."\n", 'type' => 'string', 'required' => false, 'example' => 'True', 'default' => 'False', ], ], [ 'name' => 'SearchKey', 'in' => 'query', 'schema' => [ 'description' => 'The keyword that is used for the search. The keyword can be part of an instance ID or an instance description.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rm-uf6w', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rm-uf6wjk5xxxxxxxxxx', ], ], [ 'name' => 'DBInstanceType', 'in' => 'query', 'schema' => [ 'description' => 'The role of the instance that you want to query. Valid values:'."\n" ."\n" .'* **Primary**: primary instance'."\n" .'* **Readonly**: read-only instance'."\n" .'* **Guard**: disaster recovery instance'."\n" .'* **Temp**: temporary instance'."\n" ."\n" .'By default, this operation queries the instances of all roles.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Primary', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Valid values: **1 to 100**.'."\n" ."\n" .'Default value: **30**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '30', 'default' => '30', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '0', 'example' => '1', 'default' => '1', ], ], [ 'name' => 'InstanceNetworkType', 'in' => 'query', 'schema' => [ 'description' => 'The network type of the instance. Valid values:'."\n" ."\n" .'* **Classic**'."\n" .'* **VPC**'."\n", 'type' => 'string', 'required' => false, 'example' => 'Classic', ], ], [ 'name' => 'VpcId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the virtual private cloud (VPC).'."\n", 'type' => 'string', 'required' => false, 'example' => 'vpc-j6cjvqms29yxxxxxxxxxx', ], ], [ 'name' => 'VSwitchId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the vSwitch.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vsw-j6csw46bgrgkxxxxxxxxxx', ], ], [ 'name' => 'DBInstanceClass', 'in' => 'query', 'schema' => [ 'description' => 'The instance type of the instance. For more information, see [Instance types](~~26312~~).'."\n", 'type' => 'string', 'required' => false, 'example' => 'mysql.n1.micro.1', ], ], [ 'name' => 'EngineVersion', 'in' => 'query', 'schema' => [ 'description' => 'The version of the database engine.'."\n", 'type' => 'string', 'required' => false, 'example' => '5.7', ], ], [ 'name' => 'NodeType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the database node. Valid values:'."\n" ."\n" .'* **Master**: the primary node'."\n" .'* **Slave**: the secondary node'."\n", 'type' => 'string', 'required' => false, 'example' => 'Master', ], ], [ 'name' => 'PayType', 'in' => 'query', 'schema' => [ 'description' => 'The billing method of the instance. Valid values:'."\n" ."\n" .'* **Postpaid**: pay-as-you-go'."\n" .'* **Prepaid**: subscription'."\n" ."\n" .'By default, this operation queries the instances that use any of the supported billing methods.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Postpaid', ], ], [ 'name' => 'ConnectionMode', 'in' => 'query', 'schema' => [ 'description' => 'The connection mode of the instance. Valid values:'."\n" ."\n" .'* **Standard**: standard mode'."\n" .'* **Safe**: database proxy mode'."\n" ."\n" .'By default, this operation queries the instances that use any of the supported connection modes.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Standard', ], ], [ 'name' => 'CurrentInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the current instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rm-uf6wjk5xxxxxxxxxx', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy*****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Items' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'DBInstance' => [ 'description' => 'An array that consists of the details about the instances.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Category' => [ 'description' => 'The RDS edition of the instance. Valid values:'."\n" ."\n" .'* **Basic**: RDS Basic Edition'."\n" .'* **HighAvailability**: RDS High-availability Edition'."\n" .'* **Finance**: RDS Enterprise Edition'."\n", 'type' => 'string', 'example' => 'HighAvailability', ], 'ConnectionMode' => [ 'description' => 'The connection mode of the instance. Valid values:'."\n" ."\n" .'* **Standard**: standard mode'."\n" .'* **Safe**: database proxy mode'."\n", 'type' => 'string', 'example' => 'Standard', ], 'CreateTime' => [ 'description' => 'The time when the instance was created. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2018-11-05T11:26:02Z', ], 'DBInstanceClass' => [ 'description' => 'The instance type of the instance. For more information, see [Instance types](~~26312~~).'."\n", 'type' => 'string', 'example' => 'mysql.n1.micro.1', ], 'DBInstanceDescription' => [ 'description' => 'The name of the instance. It must be 2 to 256 characters in length. The value can contain letters, digits, underscores (\\_), and hyphens (-). The value must start with a letter.'."\n" ."\n" .'> The value cannot start with http:// or https://.'."\n", 'type' => 'string', 'example' => 'Test', ], 'DBInstanceId' => [ 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5xxxxxxxxxx', ], 'DBInstanceNetType' => [ 'description' => 'The network connection type of the instance. Valid values:'."\n" ."\n" .'* **Internet**'."\n" .'* **Intranet**'."\n", 'type' => 'string', 'example' => 'Intranet', ], 'DBInstanceStatus' => [ 'description' => 'The status of the instance. For more information, see [Instance state table](~~26315~~).'."\n", 'type' => 'string', 'example' => 'Running', ], 'DBInstanceStorageType' => [ 'description' => 'The storage type of the instance. Valid values:'."\n" ."\n" .'* **local_ssd/ephemeral_ssd**: local SSD'."\n" .'* **cloud_ssd**: standard SSD.'."\n" .'* **cloud_essd**: enhanced SSD (ESSD)'."\n", 'type' => 'string', 'example' => 'local_ssd', ], 'DBInstanceType' => [ 'description' => 'The role of the instance. Valid values:'."\n" ."\n" .'* **Primary**: primary instance'."\n" .'* **Readonly**: read-only instance'."\n" .'* **Guard**: disaster recovery instance'."\n" .'* **Temp**: temporary instance'."\n", 'type' => 'string', 'example' => 'Primary', ], 'DestroyTime' => [ 'description' => 'The time when the instance was destroyed. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2018-12-05T11:26:02Z', ], 'Engine' => [ 'description' => 'The database engine of the instance. Valid values:'."\n" ."\n" .'* MySQL'."\n" .'* SQLServer'."\n" .'* PostgreSQL'."\n" .'* PPAS'."\n" .'* MariaDB'."\n", 'type' => 'string', 'example' => 'MySQL', ], 'EngineVersion' => [ 'description' => 'The version of the database engine.'."\n", 'type' => 'string', 'example' => '5.7', ], 'ExpireTime' => [ 'description' => 'The time when the instance expired. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2018-11-28T11:26:02Z', ], 'GuardDBInstanceId' => [ 'description' => 'The ID of the disaster recovery instance. This parameter is returned only when the instance is a primary instance and has a disaster recovery instance.'."\n", 'type' => 'string', 'example' => 'rm-uf64zsuxxxxxxxxxx', ], 'InsId' => [ 'description' => 'The ID of the instance role.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'InstanceNetworkType' => [ 'description' => 'The network type of the instance. Valid values:'."\n" ."\n" .'* **Classic**'."\n" .'* **VPC**'."\n", 'type' => 'string', 'example' => 'Classic', ], 'LockMode' => [ 'description' => 'The lock method of the instance. Valid values:'."\n" ."\n" .'* **Unlock**: The instance is not locked.'."\n" .'* **ManualLock**: The instance is manually locked.'."\n" .'* **LockByExpiration**: The instance is automatically locked after it expires.'."\n" .'* **LockByRestoration**: The instance is automatically locked before a rollback.'."\n" .'* **LockByDiskQuota**: The instance is automatically locked because its storage capacity is exhausted and the instance is inaccessible.'."\n", 'type' => 'string', 'example' => 'Unlock', ], 'LockReason' => [ 'description' => 'The reason why the instance was locked.'."\n", 'type' => 'string', 'example' => 'instance_expired', ], 'MasterInstanceId' => [ 'description' => 'The ID of the primary instance. If the value of this parameter is null, the instance is a primary instance.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5xxxxxxxxxx', ], 'MutriORsignle' => [ 'description' => 'Indicates whether multi-region deployment is used. Valid values:'."\n" ."\n" .'* **true**: Multi-region deployment is used.'."\n" .'* **false**: Multi-region deployment is not used.'."\n", 'type' => 'boolean', 'example' => 'false', ], 'PayType' => [ 'description' => 'The billing method of the instance. Valid values:'."\n" ."\n" .'* **Postpaid**: pay-as-you-go'."\n" .'* **Prepaid**: subscription'."\n", 'type' => 'string', 'example' => 'Postpaid', ], 'ReadOnlyDBInstanceIds' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'ReadOnlyDBInstanceId' => [ 'description' => 'An array consisting of the IDs of the read-only instances that are attached to the primary instance.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'DBInstanceId' => [ 'description' => 'The ID of the read-only instance.'."\n", 'type' => 'string', 'example' => 'rm-bpxxxxxxxxx', ], ], ], ], ], ], 'RegionId' => [ 'description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], 'ReplicateId' => [ 'description' => 'None.'."\n", 'type' => 'string', 'example' => 'N/A'."\n", ], 'ResourceGroupId' => [ 'description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'example' => 'rg-acfmyxxxxx', ], 'TempDBInstanceId' => [ 'description' => 'The ID of the temporary instance.'."\n", 'type' => 'string', 'example' => 'sub138xxxxx_rm-xxxxx', ], 'VSwitchId' => [ 'description' => 'The ID of the vSwitch.'."\n", 'type' => 'string', 'example' => 'vsw-uf6adz52c2pxxxxxxxxxx ', ], 'VpcCloudInstanceId' => [ 'description' => 'The ID of the instance in the VPC.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5xxxxxxxxxx', ], 'VpcId' => [ 'description' => 'The ID of the virtual private cloud (VPC).'."\n", 'type' => 'string', 'example' => 'vpc-bp1opxu1zkhxxxxxxxxxx', ], 'ZoneId' => [ 'description' => 'The zone ID of the instance.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou-h', ], ], ], ], ], ], 'PageNumber' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '12', ], 'PageRecordCount' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC', ], 'TotalRecordCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '120', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidDBInstanceType.ValueNotSupport', 'errorMessage' => 'The specified parameter"DBInstanceType" is not valid.', ], [ 'errorCode' => 'ApiError', 'errorMessage' => 'API error.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'staticInfo' => [ 'substitutions' => [ 'Rds::2014-08-15::DescribeDBInstances', ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Items\\": {\\n \\"DBInstance\\": [\\n {\\n \\"Category\\": \\"HighAvailability\\",\\n \\"ConnectionMode\\": \\"Standard\\",\\n \\"CreateTime\\": \\"2018-11-05T11:26:02Z\\",\\n \\"DBInstanceClass\\": \\"mysql.n1.micro.1\\",\\n \\"DBInstanceDescription\\": \\"Test\\",\\n \\"DBInstanceId\\": \\"rm-uf6wjk5xxxxxxxxxx\\",\\n \\"DBInstanceNetType\\": \\"Intranet\\",\\n \\"DBInstanceStatus\\": \\"Running\\",\\n \\"DBInstanceStorageType\\": \\"local_ssd\\",\\n \\"DBInstanceType\\": \\"Primary\\",\\n \\"DestroyTime\\": \\"2018-12-05T11:26:02Z\\",\\n \\"Engine\\": \\"MySQL\\",\\n \\"EngineVersion\\": \\"5.7\\",\\n \\"ExpireTime\\": \\"2018-11-28T11:26:02Z\\",\\n \\"GuardDBInstanceId\\": \\"rm-uf64zsuxxxxxxxxxx\\",\\n \\"InsId\\": 1,\\n \\"InstanceNetworkType\\": \\"VPC\\",\\n \\"LockMode\\": \\"Unlock\\",\\n \\"LockReason\\": \\"instance_expired\\",\\n \\"MasterInstanceId\\": \\"rm-uf6wjk5xxxxxxxxxx\\",\\n \\"MutriORsignle\\": false,\\n \\"PayType\\": \\"Postpaid\\",\\n \\"ReadOnlyDBInstanceIds\\": {\\n \\"ReadOnlyDBInstanceId\\": [\\n {\\n \\"DBInstanceId\\": \\"rm-bpxxxxxxxxx\\"\\n }\\n ]\\n },\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ReplicateId\\": \\"无\\",\\n \\"ResourceGroupId\\": \\"rg-acfmyxxxxx\\",\\n \\"TempDBInstanceId\\": \\"sub138xxxxx_rm-xxxxx\\",\\n \\"VSwitchId\\": \\"vsw-uf6adz52c2pxxxxxxxxxx\\\\t\\",\\n \\"VpcCloudInstanceId\\": \\"rm-uf6wjk5xxxxxxxxxx\\",\\n \\"VpcId\\": \\"vpc-bp1opxu1zkhxxxxxxxxxx\\",\\n \\"ZoneId\\": \\"cn-hangzhou-h\\"\\n }\\n ]\\n },\\n \\"PageNumber\\": 12,\\n \\"PageRecordCount\\": 10,\\n \\"RequestId\\": \\"1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC\\",\\n \\"TotalRecordCount\\": 120\\n}","errorExample":""},{"type":"xml","example":"120\\n10\\n1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC\\n12\\n\\n \\n HighAvailability\\n rg-acfmyxxxxx\\n Intranet\\n 2018-12-05T11:26:02Z\\n sub138xxxxx_rm-xxxxx\\n Primary\\n false\\n Classic\\n \\n rm-uf6wjk5xxxxxxxxxx\\n instance_expired\\n MySQL\\n Test\\n 5.7\\n cn-hangzhou-h\\n Running\\n mysql.n1.micro.1\\n vsw-uf6adz52c2pxxxxxxxxxx\\t\\n 2018-11-05T11:26:02Z\\n rm-uf64zsuxxxxxxxxxx\\n Unlock\\n Postpaid\\n local_ssd\\n \\n vpc-bp1opxu1zkhxxxxxxxxxx\\n rm-uf6wjk5xxxxxxxxxx\\n Standard\\n rm-uf6wjk5xxxxxxxxxx\\n cn-hangzhou\\n 2018-11-28T11:26:02Z\\n \\n \\n rm-bpxxxxxxxxx\\n \\n \\n \\n","errorExample":""}]', 'title' => 'DescribeDBInstancesForClone', 'description' => 'This operation is phased out.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeDBInstancesAsCsv' => [ 'summary' => 'Queries the instances.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => true, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the IDs of instances.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rm-uf6wjk5xxxxxxxxxx ', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy*****', ], ], [ 'name' => 'CachedAsync', 'in' => 'query', 'schema' => [ 'description' => 'A deprecated parameter. You do not need to configure this parameter.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'API', ], ], [ 'name' => 'ExportKey', 'in' => 'query', 'schema' => [ 'description' => 'A deprecated parameter. You do not need to configure this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'API', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Items' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'DBInstanceAttribute' => [ 'description' => 'An array that consists of the fields in **DBInstanceAttribute**.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The following table describes the fields.'."\n", 'type' => 'object', 'properties' => [ 'AccountMaxQuantity' => [ 'description' => 'The maximum number of accounts.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '500', ], 'AccountType' => [ 'description' => 'The type of the account.'."\n", 'type' => 'string', 'example' => 'super', ], 'AvailabilityValue' => [ 'description' => 'The service availability of the instance in percentage.'."\n", 'type' => 'string', 'example' => '100', ], 'Category' => [ 'description' => 'The category of the instance.'."\n", 'type' => 'string', 'example' => '0', ], 'ConnectionMode' => [ 'description' => 'The connection mode of the instance. Valid values:'."\n" ."\n" .'* **Performance**: standard mode.'."\n" .'* **Safety**: enhanced mode'."\n", 'type' => 'string', 'example' => 'Performance', ], 'ConnectionString' => [ 'description' => 'The internal endpoint.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5xxxxxxxxxx.mysql.rds.aliyuncs.com', ], 'CreationTime' => [ 'description' => 'The creation time.'."\n", 'type' => 'string', 'example' => '2011-05-30T12:11:04Z', ], 'DBInstanceCPU' => [ 'description' => 'The number of CPU cores.'."\n", 'type' => 'string', 'example' => '2', ], 'DBInstanceClass' => [ 'description' => 'The instance type of the instance.'."\n", 'type' => 'string', 'example' => 'rds.mys2.small', ], 'DBInstanceClassType' => [ 'description' => 'The instance family.'."\n", 'type' => 'string', 'example' => 's', ], 'DBInstanceDescription' => [ 'description' => 'The instance description.'."\n", 'type' => 'string', 'example' => '0', ], 'DBInstanceId' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5xxxxxxxxxx', ], 'DBInstanceMemory' => [ 'description' => 'The memory capacity of the instance. Unit: MB.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '4096', ], 'DBInstanceNetType' => [ 'description' => 'The network type of the instance. Valid values:'."\n" ."\n" .'* **Internet**'."\n" .'* **Intranet**'."\n", 'type' => 'string', 'example' => 'Internet', ], 'DBInstanceStatus' => [ 'description' => 'The instance status.'."\n", 'type' => 'string', 'example' => 'Running', ], 'DBInstanceStorage' => [ 'description' => 'The storage capacity of the instance. Unit: GB.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'DBInstanceType' => [ 'description' => 'The instance type. Valid values:'."\n" ."\n" .'* **Primary**: primary instance'."\n" .'* **ReadOnly**: read-only instance'."\n" .'* **Guard**: disaster recovery instance'."\n" .'* **Temp**: temporary instance'."\n", 'type' => 'string', 'example' => 'Primary', ], 'DBMaxQuantity' => [ 'description' => 'The maximum number of databases that can be created on the instance.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Engine' => [ 'description' => 'The database engine of the instance.'."\n", 'type' => 'string', 'example' => 'MySQL', ], 'EngineVersion' => [ 'description' => 'The engine version.'."\n", 'type' => 'string', 'example' => '8.0', ], 'ExpireTime' => [ 'description' => 'The expiration time.'."\n", 'type' => 'string', 'example' => '2019-03-27T16:00:00Z', ], 'ExportKey' => [ 'description' => 'A deprecated parameter. You do not need to specify this parameter.'."\n", 'type' => 'string', 'example' => 'API', ], 'GuardDBInstanceId' => [ 'description' => 'The ID of the disaster recovery instance that is attached to the primary instance.'."\n", 'type' => 'string', 'example' => 'rm-uf64zsuxxxxxxxxxx', ], 'IncrementSourceDBInstanceId' => [ 'description' => 'The ID of the instance from which incremental data comes. The incremental data of a disaster recovery instance comes from its primary instance. The incremental data of a read-only instance comes from its primary instance. If this parameter is not returned, the instance is a primary instance.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5xxxxxxxxxx', ], 'InstanceNetworkType' => [ 'description' => 'The network type.'."\n", 'type' => 'string', 'example' => 'VPC', ], 'LockMode' => [ 'description' => 'The lock mode of the instance.'."\n", 'type' => 'string', 'example' => 'Unlock', ], 'LockReason' => [ 'description' => 'The reason why the instance was locked.'."\n", 'type' => 'string', 'example' => 'instance_expired', ], 'MaintainTime' => [ 'description' => 'The maintenance window of the instance. The time follows the ISO 8601 standard and is displayed in UTC. In the ApsaraDB RDS console, the maintenance window is displayed in UTC+8.'."\n", 'type' => 'string', 'example' => '00:00Z-02:00Z', ], 'MasterInstanceId' => [ 'description' => 'The primary instance ID.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5xxxxxxxxxx', ], 'MaxConnections' => [ 'description' => 'The maximum number of concurrent connections.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '60', ], 'MaxIOPS' => [ 'description' => 'The maximum number of I/O requests per second.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '150', ], 'PayType' => [ 'description' => 'The billing method of the instance.'."\n", 'type' => 'string', 'example' => 'Postpaid', ], 'Port' => [ 'description' => 'The port that is used to connect to the instance over an internal network.'."\n", 'type' => 'string', 'example' => '3306', ], 'ReadDelayTime' => [ 'description' => 'The latency of data replication from the primary instance to the read-only instance. This parameter is valid for read-only instances.'."\n", 'type' => 'string', 'example' => '0', ], 'RegionId' => [ 'description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], 'SecurityIPList' => [ 'description' => 'The IP addresses in the whitelist.'."\n", 'type' => 'string', 'example' => '42.xx.xx.xx', ], 'SlaveZones' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'slaveRegion' => [ 'description' => 'A deprecated parameter. You do not need to specify this parameter.'."\n", 'type' => 'array', 'items' => [ 'description' => 'A deprecated parameter. You do not need to specify this parameter.'."\n", 'type' => 'string', 'example' => 'API', ], ], ], ], 'SupportUpgradeAccountType' => [ 'description' => 'N/A.'."\n", 'type' => 'string', 'example' => 'No', ], 'Tags' => [ 'description' => 'The tags.'."\n", 'type' => 'string', 'example' => '0', ], 'TempDBInstanceId' => [ 'description' => 'The ID of the temporary instance that is attached to the primary instance.'."\n", 'type' => 'string', 'example' => 'rm-uf64zsuxxxxxxxxxx', ], 'VSwitchId' => [ 'description' => 'The vSwitch ID.'."\n", 'type' => 'string', 'example' => 'vsw-uf6adz52c2pxxxxxxxxxx ', ], 'VpcId' => [ 'description' => 'The virtual private cloud (VPC) ID.'."\n", 'type' => 'string', 'example' => 'vpc-uf6f7l4fg90xxxxxxxxxx ', ], 'ZoneId' => [ 'description' => 'The zone ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou-h', ], 'DBInstanceStorageType' => [ 'type' => 'string', ], ], ], ], ], ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A444291**** ', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InstanceNames.Malformed', 'errorMessage' => 'instance number of Instance Names should be less than 3000', ], [ 'errorCode' => '400', 'errorMessage' => 'Export all instances more than 6 times in an hour, please try 1 hour later.', ], [ 'errorCode' => 'ExportLimitExceeded', 'errorMessage' => 'Export all instances more than 6 times in an hour, please try 1 hour later.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'Export.InProcess', 'errorMessage' => 'There is already a task running, please try later', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'staticInfo' => [ 'substitutions' => [ 'Rds::2014-08-15::DescribeDBInstances', ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Items\\": {\\n \\"DBInstanceAttribute\\": [\\n {\\n \\"AccountMaxQuantity\\": 500,\\n \\"AccountType\\": \\"super\\",\\n \\"AvailabilityValue\\": \\"100\\",\\n \\"Category\\": \\"0\\",\\n \\"ConnectionMode\\": \\"Performance\\",\\n \\"ConnectionString\\": \\"rm-uf6wjk5****.mysql.rds.aliyuncs.com\\",\\n \\"CreationTime\\": \\"2011-05-30T12:11:04Z\\",\\n \\"DBInstanceCPU\\": \\"2\\",\\n \\"DBInstanceClass\\": \\"rds.mys2.small\\",\\n \\"DBInstanceClassType\\": \\"s\\",\\n \\"DBInstanceDescription\\": \\"0\\",\\n \\"DBInstanceId\\": \\"rm-uf6wjk5****\\",\\n \\"DBInstanceMemory\\": 4096,\\n \\"DBInstanceNetType\\": \\"Internet\\",\\n \\"DBInstanceStatus\\": \\"Running\\",\\n \\"DBInstanceStorage\\": 10,\\n \\"DBInstanceType\\": \\"Primary\\",\\n \\"DBMaxQuantity\\": 200,\\n \\"Engine\\": \\"MySQL\\",\\n \\"EngineVersion\\": \\"8.0\\",\\n \\"ExpireTime\\": \\"2019-03-27T16:00:00Z\\",\\n \\"ExportKey\\": \\"API\\",\\n \\"GuardDBInstanceId\\": \\"rm-uf64zsu****\\",\\n \\"IncrementSourceDBInstanceId\\": \\"rm-uf6wjk5****\\",\\n \\"InstanceNetworkType\\": \\"VPC\\",\\n \\"LockMode\\": \\"Unlock\\",\\n \\"LockReason\\": \\"instance_expired\\",\\n \\"MaintainTime\\": \\"00:00Z-02:00Z\\",\\n \\"MasterInstanceId\\": \\"rm-uf6wjk5****\\",\\n \\"MaxConnections\\": 60,\\n \\"MaxIOPS\\": 150,\\n \\"PayType\\": \\"Postpaid\\",\\n \\"Port\\": \\"3306\\",\\n \\"ReadDelayTime\\": \\"0\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"SecurityIPList\\": \\"42.XX.XX.XX\\",\\n \\"SlaveZones\\": {\\n \\"slaveRegion\\": [\\n \\"API\\"\\n ]\\n },\\n \\"SupportUpgradeAccountType\\": \\"No\\",\\n \\"Tags\\": \\"0\\",\\n \\"TempDBInstanceId\\": \\"rm-uf64zs****\\",\\n \\"VSwitchId\\": \\"vsw-uf6adz52c2p****\\",\\n \\"VpcId\\": \\"vpc-uf6f7l4fg90****\\\\t \\",\\n \\"ZoneId\\": \\"cn-hangzhou-j\\",\\n \\"DBInstanceStorageType\\": \\"\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A444291****\\\\t\\"\\n}","errorExample":""},{"type":"xml","example":"1AD222E9-E606-4A42-BF6D-8A444291****\\t\\n\\n \\n \\n \\n \\n \\n 622600\\n \\n \\n \\n \\n \\n \\n rm-uf6wjk5xxxxxxxxxx\\n \\n \\n \\n \\n \\n \\n MySQL\\n \\n cn-hangzhou-h\\n \\n \\n \\n \\n vsw-uf6adz52c2pxxxxxxxxxx\\t\\n \\n \\n \\n \\n \\n \\n vpc-uf6f7l4fg90xxxxxxxxxx\\t \\n \\n \\n \\n \\n cn-hangzhou\\n \\n \\n \\n \\n","errorExample":""}]', 'title' => 'DescribeDBInstancesAsCsv', 'description' => '> The DescribeDBInstancesAsCsv operation is phased out. You can call the DescribeDBInstances operation.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ModifyDBInstanceAutoUpgradeMinorVersion' => [ 'summary' => 'Changes the method that is used to update the minor engine version of an ApsaraDB RDS for MySQL instance or an ApsaraDB RDS for PostgreSQL instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxxxxx', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5xxx', ], ], [ 'name' => 'AutoUpgradeMinorVersion', 'in' => 'query', 'schema' => [ 'description' => 'The method that is used to update the minor engine version of the instance. Valid values:'."\n" ."\n" .'* **Auto:** automatic update.'."\n" .'* **Manual**: manual update. ApsaraDB RDS automatically updates the current minor engine version of the instance only when the current minor engine version is phased out.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Auto', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'A31818D5-0550-4A81-8D13-B45948D7193F', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A31818D5-0550-4A81-8D13-B45948D7193F\\"\\n}","type":"json"}]', 'title' => 'ModifyDBInstanceAutoUpgradeMinorVersion', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> Before you call this operation, read the following documentation and make sure that you fully understand the prerequisites and impacts of this operation.'."\n" ."\n" .'* [Modify automatic update settings for an ApsaraDB RDS for MySQL instance](~~96059~~)'."\n" .'* [Modify automatic update settings for an ApsaraDB RDS for PostgreSQL instance](~~146895~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeUpgradeMajorVersionPrecheckTask' => [ 'summary' => 'Queries the check report for a major engine version upgrade of an ApsaraDB RDS for MySQL instance or ApsaraDB RDS for PostgreSQL instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pgm-bp1c808s731l****', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'* 30 (default)'."\n" .'* 50'."\n" .'* 100'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '30', 'example' => '30', 'default' => '30', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => 'The page number.'."\n" ."\n" .'Valid values: any non-zero positive integer. Default value: 1'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'default' => '1', ], ], [ 'name' => 'TargetMajorVersion', 'in' => 'query', 'schema' => [ 'description' => 'The new major engine version of the instance. The new major engine version must be later than the original major engine version.'."\n", 'type' => 'string', 'required' => false, 'example' => '12.0', ], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the upgrade check task. You can obtain the ID of the upgrade check task from the **TaskId** parameter in the response to the UpgradeDBInstanceMajorVersionPrecheck operation.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '416980000', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The details of the response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'D1586777-41B5-5F9E-81E8-93DFDD379024', ], 'PageNumber' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageRecordCount' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', ], 'TotalRecordCount' => [ 'description' => 'The total number of entries in the upgrade check report.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Items' => [ 'description' => 'The information about the upgrade check reports.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details about the upgrade check report.'."\n", 'type' => 'object', 'properties' => [ 'TargetMajorVersion' => [ 'description' => 'The new major engine version of the instance.'."\n", 'type' => 'string', 'example' => '12.0', ], 'EffectiveTime' => [ 'description' => 'The expiration time of the upgrade check report.'."\n" ."\n" .'The value of this parameter is a timestamp that follows the UNIX time format. Unit: milliseconds.'."\n", 'type' => 'string', 'example' => '1635748703000', ], 'SourceMajorVersion' => [ 'description' => 'The original major engine version of the instance.'."\n", 'type' => 'string', 'example' => '11.0', ], 'Result' => [ 'description' => 'The result of the upgrade check.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'* Success'."\n" .'* Fail'."\n" ."\n" .'> If the check result is **Fail**, you must check the value of the **Detail** parameter to obtain the information about the errors that occurred, resolve the errors, and then try again. For more information about how to resolve common errors, see [Introduction to the check report for a major engine version upgrade to an ApsaraDB RDS for PostgreSQL instance](~~218391~~).'."\n", 'type' => 'string', 'example' => 'Success', ], 'TaskId' => [ 'description' => 'The ID of the upgrade check task.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '416980000', ], 'Detail' => [ 'description' => 'The content of the upgrade check report.'."\n", 'type' => 'string', 'example' => '[user_check_report]User check success\\n[pg_upgrade_internal.log]Performing...', ], 'CheckTime' => [ 'description' => 'The time at which the upgrade check was performed.'."\n" ."\n" .'The value of this parameter is a timestamp that follows the UNIX time format. Unit: milliseconds.'."\n", 'type' => 'string', 'example' => '1635143903000', ], 'RecommendDiskSize' => [ 'description' => 'The minimum recommended disk capacity during the upgrade. Unit: GB.'."\n" ."\n" .'> This parameter is returned only for RDS for PostgreSQL instances.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'RecommendLeastMemSize' => [ 'description' => 'The minimum recommended memory size during the upgrade. Unit: GB.'."\n" ."\n" .'> This parameter is returned only for RDS for PostgreSQL instances.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '8', ], 'RecommendMemSize' => [ 'description' => 'The recommended memory size during the upgrade. Unit: GB.'."\n" ."\n" .'If the memory size of an RDS instance is greater than or equal to the recommended memory size, the RDS instance is immediately upgraded to reduce the read-only time of the instance.'."\n" ."\n" .'> This parameter is returned only for RDS for PostgreSQL instances.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '32', ], 'UpgradeMode' => [ 'type' => 'string', ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The specified DB instance name does not exist.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D1586777-41B5-5F9E-81E8-93DFDD379024\\",\\n \\"PageNumber\\": 1,\\n \\"PageRecordCount\\": 30,\\n \\"TotalRecordCount\\": 1,\\n \\"Items\\": [\\n {\\n \\"TargetMajorVersion\\": \\"12.0\\",\\n \\"EffectiveTime\\": \\"1635748703000\\",\\n \\"SourceMajorVersion\\": \\"11.0\\",\\n \\"Result\\": \\"Success\\",\\n \\"TaskId\\": 416980000,\\n \\"Detail\\": \\"[user_check_report]User check success\\\\\\\\n[pg_upgrade_internal.log]Performing...\\",\\n \\"CheckTime\\": \\"1635143903000\\",\\n \\"RecommendDiskSize\\": 100,\\n \\"RecommendLeastMemSize\\": 8,\\n \\"RecommendMemSize\\": 32,\\n \\"UpgradeMode\\": \\"\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 1\\n 30\\n D1586777-41B5-5F9E-81E8-93DFDD379024\\n 1\\n \\n 1635143903000\\n 11.0\\n 416980000\\n 1635748703000\\n 12.0\\n [user_check_report]User check success\\\\n[pg_upgrade_internal.log]Performing...\\n Success\\n \\n","errorExample":""}]', 'title' => 'DescribeUpgradeMajorVersionPrecheckTask', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'MySQL'."\n" ."\n" .'PostgreSQL'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> Before you call this operation, read the following topics and make sure that you fully understand the prerequisites and impacts of this operation.'."\n" ."\n" .'* [Check report for the major engine version upgrade of an ApsaraDB RDS for MySQL instance](~~2794383~~)'."\n" .'* [Upgrade the major engine version of an ApsaraDB RDS for PostgreSQL instance](~~203309~~)'."\n" .'* [Introduction to the check report of a major engine version upgrade for an ApsaraDB RDS for PostgreSQL instance](~~218391~~)', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeUpgradeMajorVersionTasks' => [ 'summary' => 'Queries the historical tasks for major engine version upgrades of an ApsaraDB RDS for PostgreSQL instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pgm-bp1gm3yh0ht1****', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page.'."\n" ."\n" .'Valid values: **30** to **100**.'."\n" ."\n" .'Default value: **30**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '30', 'example' => '30', 'default' => '30', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => 'The page number.'."\n" ."\n" .'Pages start from 1.'."\n" ."\n" .'Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'default' => '1', ], ], [ 'name' => 'TargetMajorVersion', 'in' => 'query', 'schema' => [ 'description' => 'The major engine version of the new instance. Valid values:'."\n" ."\n" .'* **10.0**'."\n" .'* **11.0**'."\n" .'* **12.0**'."\n" .'* **13.0**'."\n" .'* **14.0**'."\n" .'* **15.0**'."\n", 'type' => 'string', 'required' => false, 'example' => '12.0', ], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'description' => 'A reserved parameter. You do not need to specify this parameter.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '417450000', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '152E0C6D-B9C3-4468-9F2C-FEF9D9E8417B', ], 'PageNumber' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageRecordCount' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', ], 'TotalRecordCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Items' => [ 'description' => 'The tasks for major engine version upgrades.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'TargetMajorVersion' => [ 'description' => 'The major engine version of the new instance. Valid values:'."\n" ."\n" .'* **10.0**'."\n" .'* **11.0**'."\n" .'* **12.0**'."\n" .'* **13.0**'."\n" .'* **14.0**'."\n" .'* **15.0**'."\n", 'type' => 'string', 'example' => '12.0', ], 'Result' => [ 'description' => 'The status of the task.'."\n" ."\n" .'* **Success**: The task is successful.'."\n" .'* **Failed**: The task failed.'."\n" .'* **Running**: The task is in the phase in which data is being migrated to a new instance.'."\n", 'type' => 'string', 'example' => 'Success', ], 'EndTime' => [ 'description' => 'The end time of the task.'."\n" ."\n" .'This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC. Unit: milliseconds.'."\n", 'type' => 'string', 'example' => '1614237779000', ], 'StartTime' => [ 'description' => 'The start time of the task.'."\n" ."\n" .'This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC. Unit: milliseconds.'."\n", 'type' => 'string', 'example' => '1614236007000', ], 'SourceMajorVersion' => [ 'description' => 'The major engine version of the original instance.'."\n", 'type' => 'string', 'example' => '11.0', ], 'UpgradeMode' => [ 'description' => 'The upgrade mode.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'* **clone**: The system does not migrate data to the new instance and does not switch your workloads over to the new instance.'."\n" .'* **switch**: The system migrates data to the new instance and switches your workloads over to the new instance.'."\n", 'type' => 'string', 'example' => 'switch', ], 'CollectStatMode' => [ 'description' => 'The time when the system collects the statistics.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'* **After**: The system collects the statistics after a switchover.'."\n" .'* **Before**: The system collects the statistics before a switchover.'."\n", 'type' => 'string', 'example' => 'After', ], 'SourceInsName' => [ 'description' => 'The ID of the original instance.'."\n", 'type' => 'string', 'example' => 'pgm-bp1i3kkq7321****', ], 'TaskId' => [ 'description' => 'The task ID.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '342900000', ], 'TargetInsName' => [ 'description' => 'The ID of the new instance.'."\n", 'type' => 'string', 'example' => 'pgm-bp1c0v6d8092****', ], 'SwitchTime' => [ 'description' => 'The time at which your workloads are switched over from the original instance to the new instance.'."\n" ."\n" .'This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC. Unit: milliseconds.'."\n", 'type' => 'string', 'example' => '1614237539000', ], 'Detail' => [ 'description' => 'The details of the task.'."\n", 'type' => 'string', 'example' => '2021-10-27 15:03:05 --- do upgrade precheck on slave succcess.\\n2021-10-27 15:03:11 --- begin to upgrade major version, source instance will locked in readonly mode.\\n2021-10-27 15:03:21 --- upgrade master success.\\n2021-10-27 15:06:10 --- exchange source and target instance dns success.\\n', ], 'SwitchEndTime' => [ 'description' => 'The end time of the switching from the original instance to the new instance.'."\n" ."\n" .'Expressed in Unix timestamp. Unit: milliseconds.', 'type' => 'string', 'example' => '1714237539000', ], 'totalLogicRepLatencyMB' => [ 'type' => 'integer', 'format' => 'int32', ], 'totalLogicRepDelayTime' => [ 'type' => 'integer', 'format' => 'int32', ], 'zeroDownTimeConnectionString' => [ 'type' => 'string', ], 'zeroDownTimePort' => [ 'type' => 'integer', 'format' => 'int32', ], 'cutOver' => [ 'type' => 'boolean', ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"152E0C6D-B9C3-4468-9F2C-FEF9D9E8417B\\",\\n \\"PageNumber\\": 1,\\n \\"PageRecordCount\\": 30,\\n \\"TotalRecordCount\\": 1,\\n \\"Items\\": [\\n {\\n \\"TargetMajorVersion\\": \\"12.0\\",\\n \\"Result\\": \\"Success\\",\\n \\"EndTime\\": \\"1614237779000\\",\\n \\"StartTime\\": \\"1614236007000\\",\\n \\"SourceMajorVersion\\": \\"11.0\\",\\n \\"UpgradeMode\\": \\"switch\\",\\n \\"CollectStatMode\\": \\"After\\",\\n \\"SourceInsName\\": \\"pgm-bp1i3kkq7321****\\",\\n \\"TaskId\\": 342900000,\\n \\"TargetInsName\\": \\"pgm-bp1c0v6d8092****\\",\\n \\"SwitchTime\\": \\"1614237539000\\",\\n \\"Detail\\": \\"2021-10-27 15:03:05 --- do upgrade precheck on slave succcess.\\\\\\\\n2021-10-27 15:03:11 --- begin to upgrade major version, source instance will locked in readonly mode.\\\\\\\\n2021-10-27 15:03:21 --- upgrade master success.\\\\\\\\n2021-10-27 15:06:10 --- exchange source and target instance dns success.\\\\\\\\n\\",\\n \\"SwitchEndTime\\": \\"1714237539000\\",\\n \\"totalLogicRepLatencyMB\\": 1,\\n \\"totalLogicRepDelayTime\\": 10,\\n \\"zeroDownTimeConnectionString\\": \\"****.pg.rds.aliyuncs.com\\",\\n \\"zeroDownTimePort\\": 5432,\\n \\"cutOver\\": true\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 1\\n 30\\n 152E0C6D-B9C3-4468-9F2C-FEF9D9E8417B\\n 1\\n \\n pgm-bp1i3kkq7321****\\n 11.0\\n 342900000\\n \\n 1614237779000\\n 12.0\\n pgm-bp1c0v6d8092****\\n 1614236007000\\n switch\\n 2021-10-27 15:03:05 --- do upgrade precheck on slave succcess.\\\\n2021-10-27 15:03:11 --- begin to upgrade major version, source instance will locked in readonly mode.\\\\n2021-10-27 15:03:21 --- upgrade master success.\\\\n2021-10-27 15:06:10 --- exchange source and target instance dns success.\\\\n\\n 1614237539000\\n Success\\n \\n","errorExample":""}]', 'title' => 'DescribeUpgradeMajorVersionTasks', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'PostgreSQL'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'UpgradeDBInstanceEngineVersion' => [ 'summary' => 'Upgrades the major engine version of an ApsaraDB RDS for MySQL instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'paid', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxxxxx', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-uf6wjk5xxxxxxx', ], ], [ 'name' => 'EngineVersion', 'in' => 'query', 'schema' => [ 'description' => 'The major engine version that the new instance runs. Valid values:'."\n" ."\n" .'* **8.0**'."\n" .'* **5.7**'."\n" .'* **5.6**'."\n", 'type' => 'string', 'required' => true, 'example' => '5.7', ], ], [ 'name' => 'EffectiveTime', 'in' => 'query', 'schema' => [ 'description' => 'The effective time. Valid values:'."\n" ."\n" .'* **Immediate**: This is the default value.'."\n" .'* **MaintainTime**: The effective time is within the maintenance window. For more information, see ModifyDBInstanceMaintainTime.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Immediate', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '65BDA532-28AF-4122-AA39-B382721EEE64', ], 'TaskId' => [ 'description' => 'The ID of the task.'."\n", 'type' => 'string', 'example' => '10254125', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidOrderTask.NotSupport', 'errorMessage' => 'The Current InstanceId exist Order Task in RDS.', ], [ 'errorCode' => 'InvalidEVENT', 'errorMessage' => 'Current DB instance has event schedule, this operation is not supported.', ], [ 'errorCode' => 'InvalidSSLstatus', 'errorMessage' => 'Current DB instance has SSL enabled, this operation is not supported.', ], [ 'errorCode' => 'InvalidTDEstatus', 'errorMessage' => 'Current DB instance has TDE enabled, this operation is not supported.', ], [ 'errorCode' => 'InvalidDBInstanceConnType.Format', 'errorMessage' => 'Specified DB instance conn type is not valid.', ], [ 'errorCode' => 'UnsupportedReadOrBakReadState', 'errorMessage' => 'Current DB instance has read or bak read instance running in unsupported states.', ], [ 'errorCode' => 'InvalidSourceCategory', 'errorMessage' => 'specified source category is invalid.', ], [ 'errorCode' => 'InvalidBizType.Format', 'errorMessage' => 'Specified biz type is not valid.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'InvalidMinorVersion.NotFound', 'errorMessage' => 'Specified minor version does not exists.', ], [ 'errorCode' => 'ClassicNetDisabled', 'errorMessage' => 'The classic network address is currently disabled, and the instance cannot perform configuration changes.', ], ], 403 => [ [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', ], [ 'errorCode' => 'IncorrectEngineVersion', 'errorMessage' => 'The engine version does not support the operation.', ], [ 'errorCode' => 'IncorrectEngineTypeMyisam', 'errorMessage' => 'Current DB instance has MyISAM table, and it does not support this operation.', ], [ 'errorCode' => 'InvalidAccountName.Format', 'errorMessage' => 'Current DB instance has account aliyun_root,and it does not support this operation.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', ], [ 'errorCode' => 'UnsupportedReadOrBakReadState', 'errorMessage' => 'Current DB instance has read or bak read running in unsupport states', ], [ 'errorCode' => 'MaxscaleMinorVersionNotSupport', 'errorMessage' => 'The Maxscale version used by the instance is too low, please upgrade the Maxscale version first.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'ReadInstanceNotSupport', 'errorMessage' => 'Instances with read-only do not support this operation.', ], [ 'errorCode' => 'ClusterNotSupport', 'errorMessage' => 'ClusterNotSupport', ], [ 'errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', ], [ 'errorCode' => 'UnsupportedFtsIndex', 'errorMessage' => 'Current DB instance has fts index. Please delete in space fts index.', ], [ 'errorCode' => 'UnsupportedFtsIndexVersion', 'errorMessage' => 'Current DB instance has fts index. Please upgrade the minor version to a version after 20221130 and remove the space fts index.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'UnsupportedByBlueGreenDeployment', 'errorMessage' => 'Operation prohibited due to blue green deployment.', ], ], [ [ 'errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance does not exist or is not supported.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"65BDA532-28AF-4122-AA39-B382721EEE64\\",\\n \\"TaskId\\": \\"10254125\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"7463B73D-35CC-4D19-A010-6B8D65D242EF\\",\\n \\"HostId\\": \\"rds.aliyuncs.com\\",\\n \\"Code\\": \\"UnsupportedOperation\\",\\n \\"Message\\": \\"The specified action is not supported.\\"\\n}"},{"type":"xml","example":"\\n\\n\\t 65BDA532-28AF-4122-AA39-B382721EEE64\\n\\t10254125\\n\\t\\n","errorExample":""}]', 'title' => 'UpgradeDBInstanceEngineVersion', 'description' => '### Supported database engine'."\n" ."\n" .'MySQL'."\n" ."\n" .'### References'."\n" ."\n" .'> Before you call this operation, read the following documentation and make sure that you fully understand the prerequisites and impacts of this operation.'."\n" ."\n" .'[Upgrade the major engine version of an ApsaraDB RDS for MySQL instance](~~96058~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'UpgradeDBInstanceKernelVersion' => [ 'summary' => 'Updates the minor engine version of an ApsaraDB RDS instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n" ."\n" .'> * If your instance runs PostgreSQL, you must make sure that the instance uses **cloud disks**. If the instance uses local disks, you must call the [RestartDBInstance](~~26230~~) operation to restart the instance. The system automatically updates the minor engine version of the instance to the latest version during the restart.'."\n" .'> * If your instance runs SQL Server, you must make sure that the instance runs SQL Server 2019.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-bpxxxxx', ], ], [ 'name' => 'UpgradeTime', 'in' => 'query', 'schema' => [ 'description' => 'The time when the update takes effect. Valid values:'."\n" ."\n" .'* **Immediate** (default): The update takes effect immediately.'."\n" .'* **MaintainTime**: The update takes effect during the maintenance window that you specify. For more information about how to change the maintenance window, see ModifyDBInstanceMaintainTime.'."\n" .'* **SpecifyTime**: The update takes effect at the point in time you specify.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Immediate', ], ], [ 'name' => 'SwitchTime', 'in' => 'query', 'schema' => [ 'description' => 'The update time. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time must be in UTC.'."\n" ."\n" .'> This parameter takes effect only when you set **UpgradeTime** to **SpecifyTime**.'."\n", 'type' => 'string', 'required' => false, 'example' => '2020-01-15T00:00:00Z', ], ], [ 'name' => 'TargetMinorVersion', 'in' => 'query', 'schema' => [ 'description' => 'The minor engine version to which you want to update. Format:'."\n" ."\n" .'* **PostgreSQL**: `rds_postgres_00_`. Example: `rds_postgres_1200_20200830`.'."\n" ."\n" .'* **MySQL**: `_`. Examples: `rds_20200229`, `xcluster_20200229`, and `xcluster80_20200229`. The following RDS editions and MySQL versions are supported:'."\n" ."\n" .' * **rds**: RDS Basic Edition or RDS High-availability Edition'."\n" .' * **xcluster**: MySQL 5.7 on RDS Enterprise Edition'."\n" .' * **xcluster80**: MySQL 8.0 on RDS Enterprise Edition'."\n" ."\n" .'* **SQLServer**: ``. Example: `15.0.4073.23`.'."\n" ."\n" .'If you do not specify this parameter, the instance is updated to the latest minor engine version.'."\n" ."\n" .'> For more information about minor engine versions, see [Release notes of AliPG](~~126002~~), [Release notes of AliSQL](~~96060~~), and [Release notes of minor engine versions of ApsaraDB RDS for SQL Server](~~213577~~).'."\n", 'type' => 'string', 'required' => false, 'example' => 'xcluster80_20210305', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'DBInstanceName' => [ 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'rm-bpxxxxx', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'DA2ECBA0-4745-4491-9166-799FF8984AC9', ], 'TargetMinorVersion' => [ 'description' => 'The new minor engine version of the instance.'."\n", 'type' => 'string', 'example' => 'xcluster80_20210305', ], 'TaskId' => [ 'description' => 'The ID of the task.'."\n", 'type' => 'string', 'example' => '226917****', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidMinorVerison.NotFound', 'errorMessage' => 'Specify minor version not founud.', ], [ 'errorCode' => 'InstanceMissingMinorVersionAttr', 'errorMessage' => 'Specify instance has no minor_version attribute.', ], [ 'errorCode' => 'InvalidMinorVersionLowerThanInstance', 'errorMessage' => 'Specify minor version cannot not be lower than current instance.', ], [ 'errorCode' => 'InvalidMinorVersionAlreadyLatest', 'errorMessage' => 'Minor version for instance is already the latest version.', ], [ 'errorCode' => 'MissingParameter.MinorVersionTag', 'errorMessage' => 'You must specify the parameter MinorVersionTag.', ], [ 'errorCode' => 'EngineNotSupported', 'errorMessage' => 'The engine does not support the operation.', ], [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'The current instance state does not support this operation.', ], [ 'errorCode' => 'TaskExists', 'errorMessage' => 'Specified task have existed.', ], [ 'errorCode' => 'UpgradeSQLServerMinorVersionFail', 'errorMessage' => 'Upgrade Minor Version for SQLServer failed.', ], [ 'errorCode' => 'UnsupportExtendDisk.NotSupport', 'errorMessage' => 'Specified DB instance is unsupport extend disk.', ], [ 'errorCode' => 'InvalidSwitchMode.NotFound', 'errorMessage' => 'Specified Parameter UpgradeTime is Invalid.', ], [ 'errorCode' => 'InvalidDBInstanceConnType.Classic', 'errorMessage' => 'Specified DB instance ConnectionAddress include classic net.', ], [ 'errorCode' => 'IncorrectDBInstanceTdeStatus', 'errorMessage' => 'Source DB instance and Target DB instance TDEStatus does not support this operation.', ], [ 'errorCode' => 'InstanceIsSnapshotBackupNotSupportThisOperation', 'errorMessage' => 'The instance backup method is snapshot backup, this operation is not supported', ], [ 'errorCode' => 'TDEInstanceNotSupportThisOperation', 'errorMessage' => 'The instance opened TDE, this operation is not supported', ], [ 'errorCode' => 'SSLInstanceNotSupportThisOperation', 'errorMessage' => 'The instance opened SSL, upgrade is not this operation', ], [ 'errorCode' => 'BYOLInstanceNotSupportThisOperation', 'errorMessage' => 'The BYOL instance is not supported this operation', ], [ 'errorCode' => 'BYOKInstanceNotSupportThisOperation', 'errorMessage' => 'The BYOK instance is not supported this operation', ], [ 'errorCode' => 'ADInstanceNotSupportThisOperation', 'errorMessage' => 'The AD instance is not supported this operation', ], [ 'errorCode' => 'MinorVersionNotSupport', 'errorMessage' => 'The current database minor version does not support the operation.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'SecondaryAddrNotSupportThisOperation', 'errorMessage' => 'The instance has a secondary instance address, so updates are not allowed.', ], ], 403 => [ [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', ], [ 'errorCode' => 'SSLNotSupport', 'errorMessage' => 'The CharacterType of instance does not support SSL', ], [ 'errorCode' => 'OperationDenied.PrePayTypeNotSupported', 'errorMessage' => 'The operation is not permitted due to pay type of instance.', ], [ 'errorCode' => 'CurrentRecoveryModelNotSupportThisAction', 'errorMessage' => 'Current recovery model not supported this action.', ], [ 'errorCode' => 'MaxscaleMinorVersionNotSupport', 'errorMessage' => 'The Maxscale version used by the instance is too low, please upgrade the Maxscale version first.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], [ 'errorCode' => 'UnsupportedByBlueGreenDeployment', 'errorMessage' => 'Operation prohibited due to blue green deployment.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', ], [ 'errorCode' => 'InvalidMaxscaleMinorVersion.Format', 'errorMessage' => 'Specified Maxscale Minor Version is Invalid.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DBInstanceName\\": \\"rm-bp****\\",\\n \\"RequestId\\": \\"DA2ECBA0-4745-4491-9166-799FF8984AC9\\",\\n \\"TargetMinorVersion\\": \\"xcluster80_20210305\\",\\n \\"TaskId\\": \\"226917711\\"\\n}","type":"json"}]', 'title' => 'UpgradeDBInstanceKernelVersion', 'description' => '### Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" ."\n" .'### References'."\n" ."\n" .'> Before you call this operation, read the following documentation and make sure that you fully understand the prerequisites and impacts of this operation.'."\n" ."\n" .'* [Update the minor engine version of an ApsaraDB RDS for MySQL instance](~~96059~~)'."\n" .'* [Update the minor engine version of an ApsaraDB RDS for PostgreSQL instance](~~146895~~)'."\n" .'* [Update the minor engine version of an ApsaraDB RDS for SQL Server instance](~~213582~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'UpgradeDBInstanceMajorVersionPrecheck' => [ 'summary' => 'Performs a precheck before the upgrade of the major engine version of an ApsaraDB RDS for PostgreSQL instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the instance. You can call the [DescribeDBInstances](~~610396~~) operation to query the ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pgm-bp1c808s731l****', ], ], [ 'name' => 'TargetMajorVersion', 'in' => 'query', 'schema' => [ 'description' => 'The new major engine version of the instance. The new major engine version must be later than the original major engine version.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '12.0', ], ], [ 'name' => 'UpgradeMode', 'in' => 'query', 'schema' => [ 'type' => 'string', 'enum' => [], ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'DBInstanceName' => [ 'description' => 'The instance name.'."\n", 'type' => 'string', 'example' => 'pgm-bp1c808s731l****', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '99C1FEEE-FB44-5342-8EBA-DC1E1A1557A4', ], 'TargetMajorVersion' => [ 'description' => 'The new major engine version of the instance.'."\n", 'type' => 'string', 'example' => '12.0', ], 'TaskId' => [ 'description' => 'The task ID.'."\n", 'type' => 'string', 'example' => '41698****', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The specified DB instance name does not exist.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'InvalidSourceCategory', 'errorMessage' => 'specified source category is invalid.', ], [ 'errorCode' => 'InvalidBizType.Format', 'errorMessage' => 'Specified biz type is not valid.', ], [ 'errorCode' => 'InvalidTDEstatus', 'errorMessage' => 'Specified TDEStatus is not configured on the This custins.', ], [ 'errorCode' => 'MinorVersionNotSupport', 'errorMessage' => 'The current database minor version does not support the operation.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'ClassicNetDisabled', 'errorMessage' => 'The classic network address is currently disabled, and the instance cannot perform configuration changes.', ], ], 403 => [ [ 'errorCode' => 'ParamNotFound', 'errorMessage' => 'The parameter is not found for the interface.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'MaxscaleMinorVersionNotSupport', 'errorMessage' => 'The Maxscale version used by the instance is too low, please upgrade the Maxscale version first.', ], [ 'errorCode' => 'ReadInstanceNotSupport', 'errorMessage' => 'Instances with read-only do not support this operation.', ], [ 'errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'TaskHasExist', 'errorMessage' => 'The task already exists.', ], [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBInstanceName\\": \\"pgm-bp1c808s731l****\\",\\n \\"RequestId\\": \\"99C1FEEE-FB44-5342-8EBA-DC1E1A1557A4\\",\\n \\"TargetMajorVersion\\": \\"12.0\\",\\n \\"TaskId\\": \\"41698****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 41698****\\n 99C1FEEE-FB44-5342-8EBA-DC1E1A1557A4\\n 12.0\\n pgm-bp1c808s731l****\\n","errorExample":""}]', 'title' => 'UpgradeDBInstanceMajorVersionPrecheck', 'description' => '### Supported database engine'."\n" ."\n" .'PostgreSQL'."\n" ."\n" .'### References'."\n" ."\n" .'> Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.'."\n" ."\n" .'[Upgrade the major engine version of an ApsaraDB RDS for PostgreSQL instance](~~203309~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'UpgradeDBInstanceMajorVersion' => [ 'summary' => 'Initiates a task to upgrade the major engine version of an ApsaraDB RDS for PostgreSQL instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'DBInstanceClass', 'in' => 'query', 'schema' => [ 'description' => 'The new instance type of the instance. The new CPU and memory specifications of the instance must be higher than or equal to the original CPU and memory specifications. If you set the **UpgradeMode** parameter to **inPlaceUpgrade**, you **do not need to configure** this parameter.'."\n" ."\n" .'For example, you can upgrade the instance type from `pg.n2.small.2c` to `pg.n2.medium.2c`. The pg.n2.small.2c instance type provides 1 CPU core and 2 GB of memory. The pg.n2.medium.2c instance type provides 2 CPU cores and 4 GB of memory.'."\n" ."\n" .'> For more information about the instance types of ApsaraDB RDS for PostgreSQL instances, see [Instance types for primary ApsaraDB RDS for PostgreSQL instances](~~276990~~).'."\n", 'type' => 'string', 'required' => false, 'example' => 'pg.n2.medium.2c', ], ], [ 'name' => 'DBInstanceStorage', 'in' => 'query', 'schema' => [ 'description' => 'The new storage capacity of the instance. Unit: GB If you set the **UpgradeMode** parameter to **inPlaceUpgrade**, you **do not need to configure** this parameter.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'* **PL1 ESSD**: 20 GB to 32,000 GB'."\n" .'* **PL2 ESSD**: 500 GB to 3,200 GB'."\n" .'* **PL3 ESSD**: 1,500 GB to 3,200 GB'."\n" .'* **General ESSD**: 40 GB to 2,000 GB'."\n" ."\n" .'> If the original instance uses local disks, you can reduce the storage capacity of the instance when you upgrade the major engine version of the instance. For more information about the minimum storage capacity, see [Upgrade the major engine version](~~203309~~).'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'PayType', 'in' => 'query', 'schema' => [ 'description' => 'The billing method. Set the value to Postpaid.'."\n" ."\n" .'> For more information about how to change the billing method of an instance after the upgrade, see [Change the billing method of an instance from pay-as-you-go to subscription](~~96743~~).'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Postpaid', ], ], [ 'name' => 'InstanceNetworkType', 'in' => 'query', 'schema' => [ 'description' => 'The network type of the new instance. Set the value to VPC. The major engine version upgrade feature is supported only for instances that reside in VPCs.'."\n" ."\n" .'If the original instance resides in the classic network, you must migrate the instance to a VPC before you call this operation. For more information about how to view or change the network type of an instance, see [Change the network type of an ApsaraDB RDS for PostgreSQL instance](~~96761~~).'."\n", 'type' => 'string', 'required' => false, 'example' => 'VPC', ], ], [ 'name' => 'SwitchTimeMode', 'in' => 'query', 'schema' => [ 'description' => 'The point in time at which the workloads are switched over. This parameter is used together with the SwitchOver parameter. This parameter is available only when you set the **SwitchOver** parameter to **true**.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'* **Immediate**: The workloads are immediately switched over.'."\n" .'* **MaintainTime**: The workloads are switched over within the maintenance window that you specify. You can call the ModifyDBInstanceMaintainTime operation to change the maintenance window of an instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Immediate', ], ], [ 'name' => 'SwitchTime', 'in' => 'query', 'schema' => [ 'description' => 'A reserved parameter. You do not need to specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => '2021-07-10T13:15:12Z', ], ], [ 'name' => 'SwitchOver', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to switch your workloads over to the instance that runs the required major engine version based on your business requirements.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'* **true**: The system automatically switches workloads over to the instance. This configuration method is used to perform an upgrade after you verify that the new major engine version is compatible with your workloads.'."\n" .'* **false**: The system does not automatically switch your workloads over to the instance. In most cases, this configuration method is used to test whether the new major engine version is compatible with your workloads before you perform the upgrade.'."\n" ."\n" .'> '."\n" ."\n" .'* If you set this parameter to true, you must take note of the following items:'."\n" ."\n" .' * After the switchover is complete, you cannot roll your workloads back to the original instance. Proceed with caution.'."\n" .' * During the switchover, the original instance processes only read requests. We recommend that you perform the switchover during off-peak hours.'."\n" .' * If read-only instances are attached to the original instance, you can set this parameter only to false. In this case, the read-only instances that are attached to the original instance cannot be cloned. After the upgrade is complete, you must create read-only instances for the instance.'."\n" ."\n" .'* If you set this parameter to false, you must take note of the following items:'."\n" ."\n" .' * The data migration does not interrupt your workloads on the original instance.'."\n" .' * After data is migrated to the instance that runs the required major engine version, you must update the endpoint configuration in your application. This update requires you to replace the endpoint of the original instance with the endpoint of the instance that runs the required major engine version. For more information about how to view the endpoint of an instance, see [Viewing and change of the internal and public endpoints and port numbers](~~96788~~).'."\n", 'type' => 'string', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'CollectStatMode', 'in' => 'query', 'schema' => [ 'description' => 'Specify the point in time at which the system collects the statistics of the instance.'."\n" ."\n" .'* **Before**: The system collects the statistics of the instance before the switchover to ensure service stability. If the instance contains a large amount of data, the upgrade may require a long period of time.'."\n" .'* **After**: The system collects the statistics of the instance after the switchover to accelerate the upgrade. After the upgrade, if you access tables for which no statistics are generated, the query plans may be inaccurate, and your database service may be unavailable during peak hours.'."\n" ."\n" .'> If you set the SwitchOver parameter to false, the value Before specifies that the system collects the statistics of the instance before the instance starts to process read and write requests, and the value After specifies that the system collects the statistics of the instance after the instance starts to process read and write requests.'."\n", 'type' => 'string', 'required' => false, 'example' => 'After', ], ], [ 'name' => 'TargetMajorVersion', 'in' => 'query', 'schema' => [ 'description' => 'The major engine version of the new instance. The value of this parameter must be the major engine version on which an upgrade check is performed.'."\n" ."\n" .'> You can call the UpgradeDBInstanceMajorVersionPrecheck operation to perform an upgrade check.'."\n", 'type' => 'string', 'required' => false, 'example' => '13.0', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the original instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'pgm-bp1gm3yh0ht1****', ], ], [ 'name' => 'VPCId', 'in' => 'query', 'schema' => [ 'description' => 'The virtual private cloud (VPC) ID of the instance. If you set the **UpgradeMode** parameter to **inPlaceUpgrade**, you **do not need to configure** this parameter.'."\n" ."\n" .'You can call the DescribeDBInstanceAttribute operation to query the VPC ID of the original instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vpc-bp1opxu1zkhn00gzv****', ], ], [ 'name' => 'VSwitchId', 'in' => 'query', 'schema' => [ 'description' => 'The vSwitch ID of the instance that runs the required major engine version. If you set the **UpgradeMode** parameter to **inPlaceUpgrade**, you **do not need to configure** this parameter.'."\n" ."\n" .'* If the original instance runs RDS Basic Edition, configure the vSwitch ID for the instance that runs the required major engine version.'."\n" .'* If the original instance runs RDS High-availability Edition, configure the vSwitch IDs for the instance that runs the required major engine version and its secondary instance. Separate the vSwitch IDs with commas (,).'."\n" ."\n" .'> The vSwitches that you specify must reside in the same zone as the original instance. You can call the DescribeVSwitches operation to query the vSwitch IDs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vsw-bp10aqj6o4lclxdrm****,vsw-bp10aqj6o4lclxdrm****', ], ], [ 'name' => 'PrivateIpAddress', 'in' => 'query', 'schema' => [ 'description' => 'The internal IP address of the new instance. You do not need to specify this parameter. The system automatically assigns an internal IP address based on the values of the VPCId and vSwitchId parameters.'."\n", 'type' => 'string', 'required' => false, 'example' => '172.16.XX.XX', ], ], [ 'name' => 'UsedTime', 'in' => 'query', 'schema' => [ 'description' => 'A reserved parameter. You do not need to specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => '1', ], ], [ 'name' => 'Period', 'in' => 'query', 'schema' => [ 'description' => 'A reserved parameter. You do not need to specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Month', ], ], [ 'name' => 'DBInstanceStorageType', 'in' => 'query', 'schema' => [ 'description' => 'The storage type of the instance that runs the required major engine version.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'* **cloud_ssd**: standard SSD'."\n" .'* **cloud_essd**: performance level 1 (PL1) Enterprise SSD (ESSD)'."\n" .'* **cloud_essd2**: PL2 ESSD'."\n" .'* **cloud_essd3**: PL3 ESSD'."\n" .'* **general_essd**: general ESSD'."\n" ."\n" .'The major engine version upgrade feature is developed based on snapshots for cloud disks. You can select a storage type after the upgrade based on the following items:'."\n" ."\n" .'* If the original instance uses standard SSDs, set this parameter to cloud_ssd.'."\n" .'* If the original instance uses ESSDs, set this parameter to cloud_essd, cloud_essd2, cloud_essd3, or general_essd.'."\n" .'* If the original instance uses local SSDs, set this parameter to cloud_essd, cloud_essd2, cloud_essd3, or general_essd.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cloud_essd', ], ], [ 'name' => 'ZoneId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the zone to which the primary instance that runs the required major engine version belongs. If you set the **UpgradeMode** parameter to **inPlaceUpgrade**, you **do not need to configure** this parameter.'."\n" ."\n" .'You can call the DescribeRegions operation to query zone IDs.'."\n" ."\n" .'You can select a zone that belongs to the region in which the original instance resides.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-h', ], ], [ 'name' => 'ZoneIdSlave1', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the zone to which the secondary instance runs the required major engine version belongs. This parameter is available only when the original instance runs RDS High-availability Edition. If you set the **UpgradeMode** parameter to **inPlaceUpgrade**, you **do not need to configure** this parameter.'."\n" ."\n" .'You can select a zone that belongs to the region in which the original instance resides.'."\n" ."\n" .'You can call the DescribeRegions operation to query zone IDs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-h', ], ], [ 'name' => 'ZoneIdSlave2', 'in' => 'query', 'schema' => [ 'description' => 'A reserved parameter. You do not need to specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-h', ], ], [ 'name' => 'UpgradeMode', 'in' => 'query', 'schema' => [ 'description' => 'The upgrade mode. This parameter is required when you set the **SwitchOver** parameter to **true**. Valid values:'."\n" ."\n" .'* **inPlaceUpgrade**: local upgrade. The major engine version upgrade is performed on the original instance, and no new instance is created. After the upgrade, the original instance runs the required major engine version and inherits the original orders, name, tags, alert rules in CloudMonitor, and backup settings.'."\n" .'* **blueGreenDeployment**: blue-green deployment. After the major engine version of the instance is upgraded, the original instance is retained and a new instance is created. Fees are generated for the new instance based on the billing method that you specified. However, no fees are generated for the creation of the new instance. After the upgrade is complete, fees are generated for both the original and new instances and the new instance cannot enjoy the discounts provided for the original instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'inPlaceUpgrade', ], ], [ 'name' => 'CustomExtraInfo', 'in' => 'query', 'schema' => [ 'type' => 'string', ], ], [ 'name' => 'AllowDDL', 'in' => 'query', 'schema' => [ 'type' => 'boolean', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'DBInstanceId' => [ 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'pgm-bp1gm3yh0ht1****', ], 'OrderId' => [ 'description' => 'The ID of the order.'."\n", 'type' => 'string', 'example' => '21128667463****', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '006729E5-2A33-5955-89E3-651D3F44EBE6', ], 'TaskId' => [ 'description' => 'A reserved parameter.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '416980000', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidUpgradePrecheckResult', 'errorMessage' => 'The upgrade precheck failed. No successful precheck task found in the past 7 days', ], [ 'errorCode' => 'TargetEngineVersion.Parameters.NotFound', 'errorMessage' => 'targetEngineVersion is missing in the request.', ], [ 'errorCode' => 'InvalidDBInstanceStorageType', 'errorMessage' => 'The specified DBInstanceStorageType is invalid.', ], [ 'errorCode' => 'InvalidInstanceNetworkType', 'errorMessage' => 'The specified InstanceNetworkType is invalid.', ], [ 'errorCode' => 'InvalidVPCId', 'errorMessage' => 'The specified VPCId is invalid.', ], [ 'errorCode' => 'InvalidDedicatedHostGroupId', 'errorMessage' => 'The specified DedicatedHostGroupId is invalid.', ], [ 'errorCode' => 'InvalidPayType', 'errorMessage' => 'The specified PayType is invalid.', ], [ 'errorCode' => 'InvalidEngineVersion', 'errorMessage' => 'The specified EngineVersion is invalid.', ], [ 'errorCode' => 'InvalidDBInstanceStorage', 'errorMessage' => 'The specified DBInstanceStorage is invalid.', ], [ 'errorCode' => 'InvalidSwitchOver', 'errorMessage' => 'The specified SwitchOver is invalid.', ], [ 'errorCode' => 'PrimaryInstanceWithReadonlyNotSupport', 'errorMessage' => 'The specified primary instance with the read-only instance does not support the operation.', ], [ 'errorCode' => 'InvalidSwitchTimeMode', 'errorMessage' => 'The specified SwitchTimeMode is invalid.', ], [ 'errorCode' => 'InvalidSwitchTime', 'errorMessage' => 'The specified SwitchTime is invalid.', ], [ 'errorCode' => 'InvalidCollectStats', 'errorMessage' => 'The specified CollectStats is invalid.', ], [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'The current instance state does not support this operation.', ], [ 'errorCode' => 'InvalidDBinstanceClass.ValueNotSupported', 'errorMessage' => 'The specified parameter DBinstanceClass is invalid.', ], [ 'errorCode' => 'InvalidUpgradeMode', 'errorMessage' => 'The Specified UpgradeMode is not valid.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'InvalidVSwitchId.Format', 'errorMessage' => 'The specified vswitch Id format is incorrect.', ], [ 'errorCode' => 'UpgradeModeNotSupport', 'errorMessage' => 'For instances with local SSD, this upgrade Mode is not allowed. For instances with cloud SSD, it is recommended to upgrade minor version at first.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', ], [ 'errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'InvalidUpgradeMode', 'errorMessage' => 'The Specified Parameter UpgradeMode is not valid.', ], [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBInstanceId\\": \\"pgm-bp1gm3yh0ht1****\\",\\n \\"OrderId\\": \\"21128667463****\\",\\n \\"RequestId\\": \\"006729E5-2A33-5955-89E3-651D3F44EBE6\\",\\n \\"TaskId\\": 416980000\\n}","errorExample":""},{"type":"xml","example":"\\n 006729E5-2A33-5955-89E3-651D3F44EBE6\\n pgm-bp1gm3yh0ht1****\\n 21128667463****\\n","errorExample":""}]', 'title' => 'UpgradeDBInstanceMajorVersion', 'description' => '### Supported database engine'."\n" ."\n" .'PostgreSQL'."\n" ."\n" .'### References'."\n" ."\n" .'Fees are generated if the call is successful. Before you call this operation, read the following documentation and make sure that you fully understand the billing rules, prerequisites, and impacts of this operation.'."\n" ."\n" .'[Upgrade the major engine version of an ApsaraDB RDS for PostgreSQL instance](~~203309~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'AllocateInstancePublicConnection' => [ 'summary' => 'Apply for a public endpoint for an ApsaraDB RDS instance', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5*****', ], ], [ 'name' => 'ConnectionStringPrefix', 'in' => 'query', 'schema' => [ 'description' => 'The prefix of the public endpoint. A valid public endpoint is in the following format: `Prefix.Database engine.rds.aliyuncs.com`. Example: `test1234.mysql.rds.aliyuncs.com`.'."\n" ."\n" .'> The value can be 5 to 40 characters in length and can contain letters, digits, and hyphens (-). The value cannot contain any of the following characters: ~ ! # % ^ & \\* = + | {} ; : \' " , <> / ?'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test1234', ], ], [ 'name' => 'Port', 'in' => 'query', 'schema' => [ 'description' => 'The public port of the instance. Valid values: **1000 to 5999**.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '3306', ], ], [ 'name' => 'BabelfishPort', 'in' => 'query', 'schema' => [ 'description' => 'The Tabular Data Stream (TDS) port of the instance for which Babelfish is enabled.'."\n" ."\n" .'> This parameter applies only to ApsaraDB RDS for PostgreSQL instances. For more information about Babelfish for ApsaraDB RDS for PostgreSQL, see [Introduction to Babelfish](~~428613~~).'."\n", 'type' => 'string', 'required' => false, 'example' => '1433', ], ], [ 'name' => 'GeneralGroupName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the dedicated cluster to which the instance belongs. This parameter is available only when the instance is created in an ApsaraDB MyBase cluster that runs MySQL on Standard Edition.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rgc-bp1tkv8*****', ], ], [ 'name' => 'PGBouncerPort', 'in' => 'query', 'schema' => [ 'description' => 'The PgBouncer port.'."\n" ."\n" .'> This parameter is available only for instances that run PostgreSQL.'."\n", 'type' => 'string', 'required' => false, 'example' => '6432', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'ConnectionString' => [ 'description' => 'The endpoint that is used to connect to the database instance.'."\n", 'type' => 'string', 'example' => 'test*****.mysql.rds.aliyuncs.com', ], 'DbInstanceName' => [ 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'rm-bp1*****', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '65BDA532-28AF-4122-AA39-B382721EEE64', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'OtherEndpoint.Exist', 'errorMessage' => 'Other endpoint exist.', ], [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'The current instance state does not support this operation.', ], [ 'errorCode' => 'ConnectionStringContainIllegalCharacterFault', 'errorMessage' => 'The connection string contain Illegal character.', ], [ 'errorCode' => 'InvalidInstanceNetworkType', 'errorMessage' => 'The specified InstanceNetworkType is invalid.', ], [ 'errorCode' => 'InvalidConnectionString.Format', 'errorMessage' => 'Specified connection string is not valid.', ], [ 'errorCode' => 'InvalidPort.Malformed', 'errorMessage' => 'Specified port is not valid.', ], [ 'errorCode' => 'InvalidVpcIdRegion.NotSupported', 'errorMessage' => 'The specified region does not allow you to create a VPC instance.', ], [ 'errorCode' => 'InvalidInstanceNetworkType.ValueNotSupported', 'errorMessage' => 'The specified parameter "InstanceNetworkType" is not valid.', ], [ 'errorCode' => 'InvalidBizType.Format', 'errorMessage' => 'Specified biz type is not valid.', ], [ 'errorCode' => 'EndpointNum.Error', 'errorMessage' => 'The number of endpoint is too many.', ], [ 'errorCode' => 'EndpointType.NotSupport', 'errorMessage' => 'Current db type is not support specified endpoint type.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'NetworkConnectionCreating', 'errorMessage' => 'The existing network connection is already being created, please do not create it repeatedly.', ], ], 403 => [ [ 'errorCode' => 'Invalid.DbInstanceNetType', 'errorMessage' => 'The specified parameter DbInstanceNetType is not valid.', ], [ 'errorCode' => 'OperationDenied.SwitchToVPC', 'errorMessage' => 'Specified instance cannot be switched to VPC.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], [ 'errorCode' => 'UnsupportedByBlueGreenDeployment', 'errorMessage' => 'Operation prohibited due to blue green deployment.', ], ], [ [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the Aliyun RDS.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"ConnectionString\\": \\"test****.mysql.rds.aliyuncs.com\\",\\n \\"DbInstanceName\\": \\"rm-bp1****\\",\\n \\"RequestId\\": \\"65BDA532-28AF-4122-AA39-B382721EEE64\\"\\n}","errorExample":""},{"type":"xml","example":"\\n rm-bp1*****\\n 65BDA532-28AF-4122-AA39-B382721EEE64\\n test*****.mysql.rds.aliyuncs.com\\n","errorExample":""}]', 'title' => 'AllocateInstancePublicConnection', 'description' => '### Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" .'* MariaDB'."\n" ."\n" .'### References'."\n" ."\n" .'> Before you call this operation, read the following documentation and make sure that you fully understand the prerequisites and impacts of this operation.'."\n" ."\n" .'* [Apply for a public endpoint for an ApsaraDB RDS for MySQL instance](~~26128~~)'."\n" .'* [Apply for a public endpoint for an ApsaraDB RDS for PostgreSQL instance](~~97738~~)'."\n" .'* [Apply for a public endpoint for an ApsaraDB RDS for SQL Server instance](~~97736~~)'."\n" .'* [Apply for a public endpoint for an ApsaraDB RDS for MariaDB instance](~~97740~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ReleaseInstancePublicConnection' => [ 'summary' => 'Releases the public endpoint of an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-uf6wjk5xxxxxxx', ], ], [ 'name' => 'CurrentConnectionString', 'in' => 'query', 'schema' => [ 'description' => 'The public endpoint. You can call the DescribeDBInstanceNetInfo operation to query the public endpoint.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-uf6wjk5xxxx.mysql.rds.aliyuncs.com', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '65BDA532-28AF-4122-AA39-B382721EEE64', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Endpoint.NotFound', 'errorMessage' => 'Specified endpoint is not found.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'IncorrectDBSslStatus', 'errorMessage' => 'The link address has been used by SSL, modification and deletion are prohibited.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], [ 'errorCode' => 'UnsupportedByBlueGreenDeployment', 'errorMessage' => 'Operation prohibited due to blue green deployment.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"65BDA532-28AF-4122-AA39-B382721EEE64\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"7463B73D-35CC-4D19-A010-6B8D65D242EF\\",\\n \\"HostId\\": \\"rds.aliyuncs.com\\",\\n \\"Code\\": \\"UnsupportedOperation\\",\\n \\"Message\\": \\"The specified action is not supported.\\"\\n}"},{"type":"xml","example":" \\n 65BDA532-28AF-4122-AA39-B382721EEE64\\n","errorExample":""}]', 'title' => 'ReleaseInstancePublicConnection', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" .'* MariaDB'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> Before you call this operation, read the following documentation and make sure that you fully understand the prerequisites and impacts of this operation.'."\n" ."\n" .'* [Release the public endpoint of an ApsaraDB RDS for MySQL instance](~~26128~~)'."\n" .'* [Release the public endpoint of an ApsaraDB RDS for PostgreSQL instance](~~97738~~)'."\n" .'* [Release the public endpoint of an ApsaraDB RDS for SQL Server instance](~~97736~~)'."\n" .'* [Release the public endpoint of an ApsaraDB RDS for MariaDB instance](~~97740~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ModifyDBInstanceConnectionString' => [ 'summary' => 'Modifies the endpoint and port of an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5****', ], ], [ 'name' => 'CurrentConnectionString', 'in' => 'query', 'schema' => [ 'description' => 'The endpoint of the instance. It can be an internal endpoint, a public endpoint, or a classic network endpoint in hybrid access mode.'."\n" ."\n" .'> The read/write splitting endpoint cannot be changed.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5x****.mysql.rds.aliyuncs.com', ], ], [ 'name' => 'ConnectionStringPrefix', 'in' => 'query', 'schema' => [ 'description' => 'The prefix of the endpoint after the change. Only the prefix of the value of **CurrentConnectionString** can be changed.'."\n" ."\n" .'> The value must be 8 to 64 characters in length and can contain letters, digits, and hyphens (-). The value cannot contain any of the following special characters: ! # % ^ & \\* = + | {} ; : \' " ,<> / ?'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-****', ], ], [ 'name' => 'Port', 'in' => 'query', 'schema' => [ 'description' => 'The port number after the change.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '3306', ], ], [ 'name' => 'BabelfishPort', 'in' => 'query', 'schema' => [ 'description' => 'The Tabular Data Stream (TDS) port of the instance for which Babelfish is enabled.'."\n" ."\n" .'> This parameter applies only to ApsaraDB RDS for PostgreSQL instances. For more information about Babelfish for ApsaraDB RDS for PostgreSQL, see [Introduction to Babelfish](~~428613~~).'."\n", 'type' => 'string', 'required' => false, 'example' => '1433', ], ], [ 'name' => 'GeneralGroupName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the dedicated cluster to which the instance belongs. This parameter is returned only when the instance is created in an ApsaraDB MyBase cluster that runs MySQL on Standard Edition.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rgc-bp1tkv8****', ], ], [ 'name' => 'PGBouncerPort', 'in' => 'query', 'schema' => [ 'description' => 'The PgBouncer port.'."\n" ."\n" .'> This parameter is suitable only for ApsaraDB RDS for PostgreSQL instances. If you enable PgBouncer for your instance, you can change the PgBouncer port of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => '6432', ], ], [ 'name' => 'TargetDBInstanceId', 'in' => 'query', 'schema' => [ 'type' => 'string', ], ], [ 'name' => 'RetainVip', 'in' => 'query', 'schema' => [ 'type' => 'boolean', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '65BDA532-28AF-4122-AA39-B382721EEE64', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'DnsConflict', 'errorMessage' => 'Dns is conflict with other custins.', ], [ 'errorCode' => 'InvalidConnectionString.Malformed', 'errorMessage' => 'The specified parameter ConnectionStringPrefix is not valid.', ], [ 'errorCode' => 'OperationDenied.DBInstanceStatus', 'errorMessage' => 'The operation is not permitted due to status of instance.', ], [ 'errorCode' => 'InvalidConnectionString.NotFound', 'errorMessage' => 'The specified connection string or network type is not found.', ], [ 'errorCode' => 'MissingConnectionString', 'errorMessage' => 'The request is missing a ConnectionString parameter.', ], [ 'errorCode' => 'OtherEndpoint.Exist', 'errorMessage' => 'Other endpoint exist.', ], [ 'errorCode' => 'Endpoint.NotFound', 'errorMessage' => 'Specified endpoint is not found.', ], [ 'errorCode' => 'InvalidPort.Format', 'errorMessage' => 'Specified Port is not valid.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'IncorrectDBSslStatus', 'errorMessage' => 'The link address has been used by SSL, modification and deletion are prohibited.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], [ 'errorCode' => 'UnsupportedByBlueGreenDeployment', 'errorMessage' => 'Operation prohibited due to blue green deployment.', ], ], [ [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the Aliyun RDS.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"65BDA532-28AF-4122-AA39-B382721EEE64\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"7463B73D-35CC-4D19-A010-6B8D65D242EF\\",\\n \\"HostId\\": \\"rds.aliyuncs.com\\",\\n \\"Code\\": \\"UnsupportedOperation\\",\\n \\"Message\\": \\"The specified action is not supported.\\"\\n}"},{"type":"xml","example":"\\n 65BDA532-28AF-4122-AA39-B382721EEE64\\n","errorExample":""}]', 'title' => 'ModifyDBInstanceConnectionString', 'description' => '### Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" .'* MariaDB'."\n" ."\n" .'### References'."\n" ."\n" .'> Before you call this operation, read the following documentation and make sure that you fully understand the prerequisites and impacts of this operation:'."\n" ."\n" .'* [Change the endpoint and port number of an ApsaraDB RDS for MySQL instance](~~96163~~)'."\n" .'* [Change the endpoint and port number of an ApsaraDB RDS for PostgreSQL instance](~~96788~~)'."\n" .'* [Change the endpoint and port number of an ApsaraDB RDS for SQL Server instance](~~95740~~)'."\n" .'* [Change the endpoint and port number of an ApsaraDB RDS for MariaDB instance](~~97157~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ModifyDBInstanceNetworkExpireTime' => [ 'summary' => 'Changes the expiration time of the classic network endpoint of an instance in hybrid access mode.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-uf6wjk5xxxxxxx', ], ], [ 'name' => 'ConnectionString', 'in' => 'query', 'schema' => [ 'description' => 'The classic network endpoint whose expiration time you want to extend. Two types of classic network endpoints are supported:'."\n" ."\n" .'* The internal endpoint of the classic network.'."\n" .'* The read/write splitting endpoint of the classic network.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-uf6wjk5xxxxx.mysql.rds.aliyuncs.com', ], ], [ 'name' => 'ClassicExpiredDays', 'in' => 'query', 'schema' => [ 'description' => 'The retention days of the classic network endpoint. Valid values: **1 to 120**. Unit: days.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '7', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '4C467B38-3910-447D-87BC-AC049166F216', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4C467B38-3910-447D-87BC-AC049166F216\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"7463B73D-35CC-4D19-A010-6B8D65D242EF\\",\\n \\"HostId\\": \\"rds.aliyuncs.com\\",\\n \\"Code\\": \\"UnsupportedOperation\\",\\n \\"Message\\": \\"The specified action is not supported.\\"\\n}"},{"type":"xml","example":"\\n\\n\\t4C467B38-3910-447D-87BC-AC049166F216\\n \\n\\t\\n","errorExample":""}]', 'title' => 'ModifyDBInstanceNetworkExpireTime', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* SQL Server'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'* [Configure the hybrid access solution for an ApsaraDB RDS for MySQL instance](~~96110~~)'."\n" .'* [Configure the hybrid access solution for an ApsaraDB RDS for SQL Server instance](~~95708~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'SwitchDBInstanceNetType' => [ 'summary' => 'Switches between internal and public endpoints of an instance in the classic network.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCzxxxxxx', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-bp1**************', ], ], [ 'name' => 'ConnectionStringPrefix', 'in' => 'query', 'schema' => [ 'description' => 'The prefix of the custom endpoint. The prefix must be 8 to 64 characters in length and can contain letters and digits. It must start with a lowercase letter. A valid endpoint is in the following format: Prefix.Database engine.rds.aliyuncs.com. Example: test1234.mysql.rds.aliyuncs.com.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'new**********', ], ], [ 'name' => 'Port', 'in' => 'query', 'schema' => [ 'description' => 'The number of the port that is used to connect to the instance. Valid values: **3001 to 3999**.'."\n", 'type' => 'string', 'required' => false, 'example' => '3306', ], ], [ 'name' => 'ConnectionStringType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the endpoint. Valid values:'."\n" ."\n" .'* **Normal**'."\n" .'* **ReadWriteSplitting**'."\n" ."\n" .'By default, the system returns both types of endpoints.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Normal', 'default' => 'Normal', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'NewConnectionString' => [ 'description' => 'The endpoint that is used to connect to the instance after the switch of endpoints.'."\n", 'type' => 'string', 'example' => 'new**********.mysql.rds.aliyuncs.com', ], 'OldConnectionString' => [ 'description' => 'The endpoint that is used to connect to the instance before the switch of endpoints.'."\n", 'type' => 'string', 'example' => 'rm-bp1**************.mysql.rds.aliyuncs.com', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '65BDA532-28AF-4122-AA39-B382721EEE64', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"NewConnectionString\\": \\"new****.mysql.rds.aliyuncs.com\\",\\n \\"OldConnectionString\\": \\"rm-bp1****.mysql.rds.aliyuncs.com\\",\\n \\"RequestId\\": \\"65BDA532-28AF-4122-AA39-B382721EEE64\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 94D5FC3C-1314-5883-9127-61D2105515AF\\n rm-bp1qp11x5**************.rds.aliyuncs.com\\n new**********.rds.aliyuncs.com\\n","errorExample":""}]', 'title' => 'SwitchDBInstanceNetType', 'description' => '### Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* SQL Server'."\n" ."\n" .'### Prerequisites'."\n" ."\n" .'* The instance is connected by using its internal or public endpoint.'."\n" .'* The instance is in the Running state.'."\n" .'* The number of times that you have switched the instance between its internal and public endpoints within the last 24 hours does not reach 20.'."\n" .'* The instance resides in the classic network.'."\n" ."\n" .'### Usage notes'."\n" ."\n" .'After the endpoint that is used to connect to the instance is changed, you must update the endpoint information in the code of your application and restart the application.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ModifyDBInstanceNetworkType' => [ 'summary' => 'Changes the network type of an ApsaraDB RDS instance from classic network to VPC', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5xxxxxxx', ], ], [ 'name' => 'RetainClassic', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to retain the classic network endpoint. Valid values:'."\n" ."\n" .'* **True**: retains the classic network endpoint.'."\n" .'* **False** (default): does not retain the classic network endpoint.'."\n", 'type' => 'string', 'required' => false, 'example' => 'True', 'default' => 'False', ], ], [ 'name' => 'ClassicExpiredDays', 'in' => 'query', 'schema' => [ 'description' => 'The number of days for which you want to retain the classic network endpoint. Valid values: **1 to 120**. Default value: **7**.'."\n" ."\n" .'> If you set the **RetainClassic** parameter to **True**, you must also specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => '7', ], ], [ 'name' => 'InstanceNetworkType', 'in' => 'query', 'schema' => [ 'description' => 'The network type after the modification. Set the value to **VPC**.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'VPC', ], ], [ 'name' => 'ReadWriteSplittingClassicExpiredDays', 'in' => 'query', 'schema' => [ 'description' => 'The number of days for which you want to retain the read/write splitting endpoint of the classic network type. Valid values: **1 to 120**. Default value: **7**.'."\n" ."\n" .'> This parameter takes effect only when a read/write splitting endpoint of the classic network type exists and the **RetainClassic** parameter is set to **True**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '7', 'default' => '60', ], ], [ 'name' => 'VPCId', 'in' => 'query', 'schema' => [ 'description' => 'The VPC ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vpc-uf6f7l4fg90xxxxxx', ], ], [ 'name' => 'VSwitchId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the vSwitch. This parameter is required if the **VPCId** parameter is specified.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vsw-uf6adz52c2pxxxxx', ], ], [ 'name' => 'PrivateIpAddress', 'in' => 'query', 'schema' => [ 'description' => 'The internal IP address of the instance. The internal IP address must be within the CIDR block supported by the specified vSwitch. The system automatically assigns a private IP address to an instance based on the values of **VPCId** and **VSwitchId**.'."\n", 'type' => 'string', 'required' => false, 'example' => '172.10.40.25', ], ], [ 'name' => 'ReadWriteSplittingPrivateIpAddress', 'in' => 'query', 'schema' => [ 'description' => 'The internal IP address that corresponds to the read/write splitting endpoint of the instance. The internal IP address must be within the CIDR block supported by the specified vSwitch. The system automatically assigns a private IP address to an instance based on the values of **VPCId** and **VSwitchId**.'."\n" ."\n" .'> This parameter is valid when a read/write splitting endpoint of the classic network type exists.'."\n", 'type' => 'string', 'required' => false, 'example' => '192.168.0.22', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'ConnectionString' => [ 'description' => 'The endpoint that is used to connect to the instance.'."\n", 'type' => 'string', 'example' => 'rm-bp1*****************.mysql.rds.aliyuncs.com', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', ], 'TaskId' => [ 'description' => 'The ID of the task.'."\n", 'type' => 'string', 'example' => '1025486523574', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'NetTypeExists', 'errorMessage' => 'Specified network type already exists.', ], [ 'errorCode' => 'VswitchIpExhausted', 'errorMessage' => 'Vswitch IP exhausted.', ], [ 'errorCode' => 'OperationDenied.Switch', 'errorMessage' => 'The specified instance must not be switched to VPC.', ], [ 'errorCode' => 'OperationDenied.DBInstanceNetType', 'errorMessage' => 'Operation is denied by the network type of current database instance.', ], [ 'errorCode' => 'OperationDenied.DBInstanceStatus', 'errorMessage' => 'Operation is denied by the current database instance status.', ], [ 'errorCode' => 'OperationNotSupported', 'errorMessage' => 'This operation is not currently supported.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OperationDenied.DBInstanceConnType', 'errorMessage' => 'The current DB instance connection type does not support this operation.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"ConnectionString\\": \\"rm-bp1****.mysql.rds.aliyuncs.com\\",\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"TaskId\\": \\"1025486523574\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 9F0F1B7B-ED7A-5767-ADA5-46F31121E1D4\\n rm-bp1*****************.mysql.rds.aliyuncs.com\\n","errorExample":""}]', 'title' => 'ModifyDBInstanceNetworkType', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* RDS MySQL'."\n" .'* RDS PostgreSQL'."\n" .'* RDS SQL Server'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> : Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.'."\n" ."\n" .'* [Change the network type of an ApsaraDB RDS for MySQL instance](~~96109~~)'."\n" .'* [Change the network type of an ApsaraDB RDS for PostgreSQL instance](~~96761~~)'."\n" .'* [Change the network type of an ApsaraDB RDS for SQL Server instance](~~95707~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'SwitchDBInstanceVpc' => [ 'summary' => 'Changes the virtual private cloud (VPC) and vSwitch for an ApsaraDB RDS instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5*****', ], ], [ 'name' => 'VPCId', 'in' => 'query', 'schema' => [ 'description' => 'The VPC ID.'."\n" ."\n" .'> The VPC must reside in the same region as the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'vpc-uf6f7l4fg90*****', ], ], [ 'name' => 'VSwitchId', 'in' => 'query', 'schema' => [ 'description' => 'The vSwitch ID of the instance.'."\n" ."\n" .'> The vSwitch must belong to the same zone as the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'vsw-uf6adz52c2p*****', ], ], [ 'name' => 'PrivateIpAddress', 'in' => 'query', 'schema' => [ 'description' => 'The private IP address of the instance. The private IP address must be within the CIDR block of the vSwitch that is specified by the **VSwitchId** parameter.'."\n" ."\n" .'> You can call the DescribeVSwitches operation to query the CIDR block of the vSwitch.'."\n", 'type' => 'string', 'required' => false, 'example' => '10.23.XX.XX', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'MigrateAlreadyExistsFault', 'errorMessage' => 'Duplicate migration is forbidden.', ], [ 'errorCode' => 'InvalidConnVPCId', 'errorMessage' => 'Specified conn vpc id is not valid.', ], [ 'errorCode' => 'InvalidInstanceKind.NotSupport', 'errorMessage' => 'The instance kind does not support this operation.', ], [ 'errorCode' => 'InvalidPrivateIpAddress.Mismatch', 'errorMessage' => 'Specified private IP address is not in the CIDR block of virtual switch.', ], [ 'errorCode' => 'MigrateAlreadyReadWriteSplitExistsFault', 'errorMessage' => 'The rds instance already has a given vpc migrate task.', ], [ 'errorCode' => 'APICallingFailed', 'errorMessage' => 'Api calling failed.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'InvalidClassicNetworkType.NotSupport', 'errorMessage' => 'The classic network type instance does not support this operation.', ], [ 'errorCode' => 'InvalidParamForXfs', 'errorMessage' => 'Xfs instance must be single tenant standard instance.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 1AD222E9-E606-4A42-BF6D-8A4442913CEF\\n","errorExample":""}]', 'title' => 'SwitchDBInstanceVpc', 'description' => '### Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" ."\n" .'### References'."\n" ."\n" .'> Before you call this operation, read the following documentation and make sure that you fully understand the prerequisites and impacts of this operation.'."\n" ."\n" .'* [Change the VPC and vSwitch for an ApsaraDB RDS for MySQL instance](~~137567~~)'."\n" .'* [Change the vSwitch for an ApsaraDB RDS for PostgreSQL instance](~~146885~~)'."\n" .'* [Change the VPC and vSwitch for an ApsaraDB RDS for SQL Server instance](~~347675~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ModifyDBInstanceConfig' => [ 'summary' => 'Modifies the configuration item of an instance.', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-uf6wjk5xxxxxxxxxx', ], ], [ 'name' => 'ConfigName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the configuration item that you want to modify. Valid values:'."\n" ."\n" .'* **pgbouncer**. This configuration item is supported for ApsaraDB RDS for PostgreSQL instances.'."\n" .'* **clear_errorlog**. This configuration item is supported for ApsaraDB RDS for SQL Server instances.'."\n", 'type' => 'string', 'required' => true, 'example' => 'pgbouncer', ], ], [ 'name' => 'ConfigValue', 'in' => 'query', 'schema' => [ 'description' => 'The value of the configuration item that you want to modify. Valid values:'."\n" ."\n" .'* If you set ConfigName to pgbouncer, the valid values are **true** and **false**.'."\n" .'* If you set ConfigName to clear_errorlog, set the value to **1**. The value 1 indicates that error logs are cleaned up.'."\n", 'type' => 'string', 'required' => true, 'example' => 'true', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The resource group ID. You can call the DescribeDBInstanceAttribute to obtain the resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-bp67acfmxazb4p****', ], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => '6000170000591aed949d0f****', ], ], [ 'name' => 'SwitchTime', 'in' => 'query', 'schema' => [ 'description' => 'The update time. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time must be in UTC.', 'type' => 'string', 'required' => false, 'example' => '2022-05-06T09:24:00Z', ], ], [ 'name' => 'SwitchTimeMode', 'in' => 'query', 'schema' => [ 'description' => 'The time at which the modification takes effect. Valid values:'."\n" ."\n" .'- **Immediate**: immediately modifies the parameter. This is the default value.'."\n" .'- **MaintainTime**: modifies the parameter during the maintenance window of the instance. You can call the ModifyDBInstanceMaintainTime operation to change the maintenance window.'."\n" .'- **ScheduleTime**: modifies the parameter at the point in time that you specify. If you specify this value, you must also specify **SwitchTime**.', 'type' => 'string', 'required' => false, 'example' => 'Immediate', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '76364A52-E0AB-5CC8-9818-CF1DC482C092', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => '%s', 'errorMessage' => 'DB Operation Failed:%s.', ], [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The specified DB instance name does not exist.', ], [ 'errorCode' => 'MinorVersionNotSupport', 'errorMessage' => 'The current database minor version does not support the operation.', ], [ 'errorCode' => 'InvalidConfigName', 'errorMessage' => 'The ConfigName is not valid.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'InvalidSourceCategory', 'errorMessage' => 'specified source category is invalid.', ], [ 'errorCode' => 'InvalidParameter', 'errorMessage' => 'Invalid parameter.', ], [ 'errorCode' => 'InvalidConfigValue', 'errorMessage' => 'The ConfigValue is not valid.', ], [ 'errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'Specified parameters is not valid.', ], [ 'errorCode' => 'DuckDBOperationConflictBetweenPrimaryAndReadOnlyInstance', 'errorMessage' => 'Current instance is already attached to another duckdb instance, operation is conflict.', ], ], 403 => [ [ 'errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', ], [ 'errorCode' => 'CloudDiskEncryptionNotSupport', 'errorMessage' => 'The encryption key is not allowed for general-purpose instance.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], [ 'errorCode' => 'UnsupportedByBlueGreenDeployment', 'errorMessage' => 'Operation prohibited due to blue green deployment.', ], [ 'errorCode' => 'EncryptionKeyNotSupport', 'errorMessage' => 'The encryption key is not support to generate encryption disk.', ], [ 'errorCode' => 'IncorrectDBState', 'errorMessage' => 'The current DB state does not support this operation.', ], [ 'errorCode' => 'UnsupportedReadOrBakReadState', 'errorMessage' => 'Current DB instance has read or bak read running in unsupport states', ], [ 'errorCode' => 'IncorrectAccountPrivilegeType', 'errorMessage' => 'the current account privilege type does not support this operation.', ], [ 'errorCode' => 'DBInstanceStatusNotActive', 'errorMessage' => 'The status of the current instance is not active.', ], [ 'errorCode' => 'ReadOnlyInstanceNotSupport', 'errorMessage' => 'Read-only instance does not support this operation.', ], [ 'errorCode' => 'Invalid.Parameter', 'errorMessage' => 'Specified parameters is not valid.', ], [ 'errorCode' => 'TargetMajorVesionNotSupported', 'errorMessage' => 'The specified major version is not supported.', ], [ 'errorCode' => 'ReadInstanceNotSupport', 'errorMessage' => 'Instances with read-only do not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstance', 'errorMessage' => 'The current DB instance does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'Specified instance does not exist or not support.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], [ 'errorCode' => 'InvalidAccountName.NotFound', 'errorMessage' => 'The specified account is not found.', ], [ 'errorCode' => 'InvalidReadDBInstance.NotFound', 'errorMessage' => 'The specified read only database instance does not exist.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"76364A52-E0AB-5CC8-9818-CF1DC482C092\\"\\n}","type":"json"}]', 'title' => 'ModifyDBInstanceConfig', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" ."\n" .'> The configuration items that are supported are pgbouncer and clear_errorlog. For more information, see [PgBouncer of ApsaraDB RDS for PostgreSQL instances](~~2398301~~) and [Error log cleanup of ApsaraDB RDS for SQL Server instances](~~95645~~).'."\n", ], 'DescribeDBInstanceNetInfo' => [ 'summary' => 'Queries all endpoints of an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOC*****', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5*****', ], ], [ 'name' => 'Flag', 'in' => 'query', 'schema' => [ 'description' => 'A reserved parameter. You do not need to specify this parameter.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => 'None'."\n", 'default' => '1', ], ], [ 'name' => 'DBInstanceNetRWSplitType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the endpoint. Valid values:'."\n" ."\n" .'* **Normal**: regular endpoint'."\n" .'* **ReadWriteSplitting**: read/write splitting endpoint'."\n" ."\n" .'> By default, the system returns both types of endpoints.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Normal', 'title' => '', ], ], [ 'name' => 'GeneralGroupName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the dedicated cluster to which the instance belongs. This parameter takes effect only when the instance runs MySQL on RDS Standard Edition and is created in a dedicated cluster.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rgc-2ze*****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'DBInstanceNetInfos' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'DBInstanceNetInfo' => [ 'description' => 'The information about the endpoints of the instance.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'BabelfishPort' => [ 'description' => 'The Tabular Data Stream (TDS) port of the instance for which Babelfish is enabled.'."\n" ."\n" .'> This parameter applies only to ApsaraDB RDS for PostgreSQL instances. For more information about Babelfish for ApsaraDB RDS for PostgreSQL, see [Introduction to Babelfish](~~428613~~).'."\n", 'type' => 'string', 'example' => '1433', ], 'ConnectionString' => [ 'description' => 'The endpoint of the instance.'."\n", 'type' => 'string', 'example' => 'rm-uf6w*****.mysql.rds.aliyuncs.com', ], 'ConnectionStringType' => [ 'description' => 'The type of the endpoint. Valid values:'."\n" ."\n" .'* **Normal**: a regular endpoint'."\n" .'* **ReadWriteSplitting**: a read/write splitting endpoint'."\n", 'type' => 'string', 'example' => 'Normal', ], 'DBInstanceWeights' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'DBInstanceWeight' => [ 'description' => 'The information about the instance weight.'."\n" ."\n" .'> This parameter is returned only when the read/write splitting feature is enabled for the instance.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Availability' => [ 'description' => 'The availability of the instance. Valid values:'."\n" ."\n" .'* **Unavailable**'."\n" .'* **Available**'."\n", 'type' => 'string', 'example' => 'Unavailable', ], 'DBInstanceId' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5*****', ], 'DBInstanceType' => [ 'description' => 'The type of the instance. Valid values:'."\n" ."\n" .'* **Master**: primary instance'."\n" .'* **Readonly**: read-only instance'."\n", 'type' => 'string', 'example' => 'Master', ], 'Role' => [ 'description' => 'A deprecated parameter.'."\n", 'type' => 'string', 'example' => 'None'."\n", ], 'Weight' => [ 'description' => 'The weight of the instance.'."\n", 'type' => 'string', 'example' => '100', ], ], ], ], ], ], 'DistributionType' => [ 'description' => 'The policy that is used to assign read weights. This parameter is returned only for a read/write splitting endpoint. Valid values:'."\n" ."\n" .'* **Standard**: The system automatically allocates read weights to the instance and its read-only instances based on the specifications of the instances.'."\n" .'* **Custom**: You must manually allocate read weights to the instance and its read-only instances.'."\n", 'type' => 'string', 'example' => 'Standard', ], 'ExpiredTime' => [ 'description' => 'The remaining validity period of the instance in the classic network in hybrid access mode. Unit: seconds.'."\n", 'type' => 'string', 'example' => '1209534', ], 'IPAddress' => [ 'description' => 'The IP address.'."\n", 'type' => 'string', 'example' => '192.168.XX.XX', ], 'IPType' => [ 'description' => 'The network type.'."\n" ."\n" .'* Valid values when the instance resides in the classic network:'."\n" ."\n" .' * **Inner**'."\n" .' * **Public**'."\n" ."\n" .'* Valid values when the instance resides in a virtual private cloud (VPC):'."\n" ."\n" .' * **Private**'."\n" .' * **Public**'."\n", 'type' => 'string', 'example' => 'Public', ], 'MaxDelayTime' => [ 'description' => 'The latency threshold. This parameter is returned only for a read/write splitting endpoint. Unit: seconds.'."\n" ."\n" .'> If the latency on a read-only instance exceeds the specified threshold, ApsaraDB RDS no longer forwards read requests to the read-only instance.'."\n", 'type' => 'string', 'example' => '12', ], 'PGBouncerPort' => [ 'description' => 'The PgBouncer port.'."\n" ."\n" .'> This parameter is returned only when PgBouncer is enabled for the instance that runs PostgreSQL.'."\n", 'type' => 'string', 'example' => '6432', ], 'Port' => [ 'description' => 'The port that is used to connect to the instance.'."\n", 'type' => 'string', 'example' => '3306', ], 'SecurityIPGroups' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'securityIPGroup' => [ 'description' => 'The IP addresses in the whitelist for the instance.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'SecurityIPGroupName' => [ 'description' => 'The name of the IP address whitelist.'."\n", 'type' => 'string', 'example' => 'Default', ], 'SecurityIPs' => [ 'description' => 'The IP address in the whitelist.'."\n", 'type' => 'string', 'example' => '127.0.XX.XX', ], ], ], ], ], ], 'Upgradeable' => [ 'description' => 'Indicates whether the IP version can be updated. Valid values:'."\n" ."\n" .'* **Enable**'."\n" .'* **Disabled**'."\n" ."\n" .'> The IP version can be updated from IPv4 to IPv6.'."\n", 'type' => 'string', 'example' => 'Disabled', ], 'VPCId' => [ 'description' => 'The VPC ID of the instance.'."\n", 'type' => 'string', 'example' => 'vpc-uf6f7l4fg90*****', ], 'VSwitchId' => [ 'description' => 'The vSwitch ID.'."\n", 'type' => 'string', 'example' => 'vsw-uf6adz52c2p*****', ], ], ], ], ], ], 'InstanceNetworkType' => [ 'description' => 'The network type of the instance. Valid values:'."\n" ."\n" .'* **Classic**: classic network'."\n" .'* **VPC**: virtual private cloud (VPC)'."\n", 'type' => 'string', 'example' => 'VPC', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '777C4593-8053-427B-99E2-105593277CAB', ], 'SecurityIPMode' => [ 'description' => 'The whitelist mode of the instance. Valid values:'."\n" ."\n" .'* **normal**: standard whitelist mode'."\n" .'* **safety**: enhanced whitelist mode'."\n", 'type' => 'string', 'example' => 'safety', ], ], 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'TimeoutRetryLater', 'errorMessage' => 'Timeout, retry later.', ], [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'DB instance name not found.', ], [ 'errorCode' => 'IllegalParameter', 'errorMessage' => 'Illegal parameter', ], [ 'errorCode' => 'Readins.NotFound', 'errorMessage' => 'Readonly instance not found.', ], [ 'errorCode' => 'MissingRWSplistParam', 'errorMessage' => 'Custins is missing rw split param.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBInstanceNetInfos\\": {\\n \\"DBInstanceNetInfo\\": [\\n {\\n \\"BabelfishPort\\": \\"1433\\",\\n \\"ConnectionString\\": \\"rm-uf6w****.mysql.rds.aliyuncs.com\\",\\n \\"ConnectionStringType\\": \\"Normal\\",\\n \\"DBInstanceWeights\\": {\\n \\"DBInstanceWeight\\": [\\n {\\n \\"Availability\\": \\"Unavailable\\",\\n \\"DBInstanceId\\": \\"rm-uf6wjk5****\\",\\n \\"DBInstanceType\\": \\"Master\\",\\n \\"Role\\": \\"无\\",\\n \\"Weight\\": \\"100\\"\\n }\\n ]\\n },\\n \\"DistributionType\\": \\"Standard\\",\\n \\"ExpiredTime\\": \\"1209534\\",\\n \\"IPAddress\\": \\"192.168.XX.XX\\",\\n \\"IPType\\": \\"Public\\",\\n \\"MaxDelayTime\\": \\"12\\",\\n \\"PGBouncerPort\\": \\"6432\\",\\n \\"Port\\": \\"3306\\",\\n \\"SecurityIPGroups\\": {\\n \\"securityIPGroup\\": [\\n {\\n \\"SecurityIPGroupName\\": \\"Default\\",\\n \\"SecurityIPs\\": \\"127.0.XX.XX\\"\\n }\\n ]\\n },\\n \\"Upgradeable\\": \\"Disabled\\",\\n \\"VPCId\\": \\"vpc-uf6f7l4fg90*****\\",\\n \\"VSwitchId\\": \\"vsw-uf6adz52c2p****\\"\\n }\\n ]\\n },\\n \\"InstanceNetworkType\\": \\"VPC\\",\\n \\"RequestId\\": \\"777C4593-8053-427B-99E2-105593277CAB\\",\\n \\"SecurityIPMode\\": \\"safety\\"\\n}","errorExample":""},{"type":"xml","example":"\\n \\n rm-uf6wjk5*****.mysql.rds.aliyuncs.com\\n Normal\\n 192.168.XX.XX\\n Public\\n 3306\\n Disabled\\n \\n \\n Classic\\n 777C4593-8053-427B-99E2-105593277CAB\\n","errorExample":""}]', 'title' => 'DescribeDBInstanceNetInfo', 'description' => '### Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" .'* MariaDB'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeVSwitches' => [ 'summary' => 'Queries the details of vSwitch that are available in a virtual private cloud (VPC).', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the VSwitch. You can call the DescribeRegions operation to query the most recent region list.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'default' => 'cn-hangzhou', ], ], [ 'name' => 'VpcId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the VPC to which the vSwitch belongs.'."\n" ."\n" .'> You must configure this parameter or **DedicatedHostGroupId**.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'vpc-bp1opxu1zkhn**********', ], ], [ 'name' => 'ZoneId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the zone to which the vSwitch belongs. You can call the DescribeAvailableZones operation to query zone IDs. If you specify this parameter, the query results are filtered based on the value of this parameter and only the details of the VSwitch that is deployed in the specified zone are returned.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-i', ], ], [ 'name' => 'DedicatedHostGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The dedicated cluster ID. You can call the DescribeDedicatedHostGroups operation to query the dedicated cluster ID. If you specify this parameter, the details of all VSwitches in the VPC to which the dedicated cluster belongs are returned.'."\n" ."\n" .'> You must specify this parameter or the **VpcId** parameter.', 'type' => 'string', 'required' => false, 'example' => 'dhg-7a9********', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Valid values: **1 to 50**. Default value: **30**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'default' => '30', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-bp67acfmxazb4p****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'PageNumber' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned on each page. The value of this parameter is the same as the value of the **PageSize** parameter in the request parameters.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '8A68AEA1-AFBD-53F8-9BBB-06555EAE5C0E', ], 'TotalCount' => [ 'description' => 'The total number of returned entries.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'VSwitchs' => [ 'description' => 'Details of the vSwitches.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the vSwitch.'."\n", 'type' => 'object', 'properties' => [ 'AvailableIpAddressCount' => [ 'description' => 'The number of available IP addresses in the vSwitch.'."\n", 'type' => 'string', 'required' => true, 'example' => '1', ], 'CidrBlock' => [ 'description' => 'The CIDR block of the vSwitch.'."\n", 'type' => 'string', 'example' => '172.16.0.0/24', ], 'Description' => [ 'description' => 'The description of the vSwitch.'."\n", 'type' => 'string', 'example' => 'vSwitchDescription', ], 'IsDefault' => [ 'description' => 'Indicates whether the vSwitch is the default vSwitch. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'IzNo' => [ 'description' => 'The ID of the zone to which the vSwitch belongs.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou-h', ], 'Status' => [ 'description' => 'The status of the vSwitch. Valid values:'."\n" ."\n" .'* **Pending**: The vSwitch is being specified.'."\n" .'* **Available**: The vSwitch is available.'."\n", 'type' => 'string', 'example' => 'Available', ], 'VSwitchId' => [ 'description' => 'The vSwitch ID.'."\n", 'type' => 'string', 'example' => 'vsw-bp1pnaz94xc**********', ], 'VSwitchName' => [ 'description' => 'The vSwitch name.'."\n", 'type' => 'string', 'example' => 'test', ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidVSwitchId.NotFound', 'errorMessage' => 'Specified virtual switch is not found in specified VPC.', ], [ 'errorCode' => 'IncorrecttVpcId', 'errorMessage' => 'The specified parameter VPCId is not valid.', ], [ 'errorCode' => 'InvalidIzNo.NotSupported', 'errorMessage' => 'Specified VPC zone is not supported.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"RequestId\\": \\"8A68AEA1-AFBD-53F8-9BBB-06555EAE5C0E\\",\\n \\"TotalCount\\": 2,\\n \\"VSwitchs\\": [\\n {\\n \\"AvailableIpAddressCount\\": \\"1\\",\\n \\"CidrBlock\\": \\"172.16.XX.XX/24\\",\\n \\"Description\\": \\"vSwitchDescription\\",\\n \\"IsDefault\\": true,\\n \\"IzNo\\": \\"cn-hangzhou-j\\",\\n \\"Status\\": \\"Available\\",\\n \\"VSwitchId\\": \\"vsw-bp1pnaz94xc****\\",\\n \\"VSwitchName\\": \\"test\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n \\n false\\n Available\\n cn-hangzhou-h\\n \\n vsw-bp1pnaz94xc**********\\n 192.168.0.1/24\\n test\\n \\n \\n true\\n Available\\n cn-hangzhou-h\\n System created default virtual switch.\\n vsw-bp10aqj6o4l**********\\n 172.16.0.1/20\\n \\n \\n 2\\n A5362A78-1B78-53D7-AFBA-E375D9C26F2F\\n 30\\n 1\\n","errorExample":""}]', 'title' => 'DescribeVSwitches', 'description' => '### Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" .'* MariaDB'."\n", ], 'ModifyDBInstanceHAConfig' => [ 'summary' => 'Changes the high availability (HA) and data replication mode of an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'SyncMode', 'in' => 'query', 'schema' => [ 'description' => 'The data replication mode of the instance. For more information, see [Data replication mode](~~96055~~).'."\n" ."\n" .'* Semi-sync: the semi-synchronous mode.'."\n" .'* Sync: the synchronous mode.'."\n" .'* gAsyncg: the asynchronous mode.'."\n" .'* Mgr: the MySQL group replication (MGR) mode. This mode is available only for the China site (aliyun.com).'."\n" ."\n" .'> This parameter is not supported for instances that run SQL Server 2017 on RDS Cluster Edition.'."\n", 'type' => 'string', 'required' => true, 'enumValueTitles' => [], 'example' => 'Sync', ], ], [ 'name' => 'HAMode', 'in' => 'query', 'schema' => [ 'description' => 'The HA mode of the instance.'."\n" ."\n" .'* RPO: Data consistency is preferred. The instance ensures data reliability to minimize data losses. If you have high requirements on data consistency, select this mode.'."\n" .'* RTO: Service availability is preferred. The instance restores the database service at the earliest opportunity to ensure service availability. If you have high requirements for service availability, select this mode.'."\n", 'type' => 'string', 'required' => true, 'enumValueTitles' => [], 'example' => 'RPO', ], ], [ 'name' => 'DbInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-uf6wjk543xxxxx', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'D4D4BE8A-DD46-440A-BFCD-EE31DA81C9DD', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'GroupReplicationNotSupport.InvalidEngineVersion', 'errorMessage' => 'Group Replication requires the instance engine version to be 8.0.', ], [ 'errorCode' => 'GroupReplicationNotSupport.InvalidNodeClassCode', 'errorMessage' => 'Group Replication requires the ClassCode of each node to be consistent.', ], [ 'errorCode' => 'GroupReplicationNotSupport.InvalidNodeNum', 'errorMessage' => 'Group Replication is not supported, the number of nodes must be an odd number greater than or equal to 3.', ], [ 'errorCode' => 'GroupReplicationNotSupport.InvalidXengine', 'errorMessage' => 'Group Replication is not supported because the instance has xengine tables.', ], [ 'errorCode' => 'GroupReplicationNotSupport.MemoryTooSmall', 'errorMessage' => 'Group Replication is not supported because the memory is too small.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'GroupReplicationNotSupport.TableWithoutPrimaryKey', 'errorMessage' => 'Group Replication is not supported because the instance exists table has no primary key.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D4D4BE8A-DD46-440A-BFCD-EE31DA81C9DD\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"7463B73D-35CC-4D19-A010-6B8D65D242EF\\",\\n \\"HostId\\": \\"rds.aliyuncs.com\\",\\n \\"Code\\": \\"UnsupportedOperation\\",\\n \\"Message\\": \\"The specified action is not supported.\\"\\n}"},{"type":"xml","example":"\\n\\n\\tD4D4BE8A-DD46-440A-BFCD-EE31DA81C9DD\\n\\n\\t\\n","errorExample":""}]', 'title' => 'ModifyDBInstanceHAConfig', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ModifyHASwitchConfig' => [ 'summary' => 'Enables or disables the automatic primary/secondary switchover feature for an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5xxxxxxxxxx', ], ], [ 'name' => 'HAConfig', 'in' => 'query', 'schema' => [ 'description' => 'The mode of the automatic primary/secondary switchover feature. Valid values:'."\n" ."\n" .'* **Auto**: The automatic primary/secondary switchover feature is enabled. The system automatically switches your workloads over from the instance to its secondary instance in the event of a fault.'."\n" .'* **Manual**: The automatic primary/secondary switchover feature is disabled. You must manually switch your workloads over from the instance to its secondary instance in the event of a fault.'."\n" ."\n" .'Default value: **Auto**.'."\n" ."\n" .'> If you set this parameter to **Manual**, you must specify the **ManualHATime** parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Manual', ], ], [ 'name' => 'ManualHATime', 'in' => 'query', 'schema' => [ 'description' => 'The time to disable the automatic primary/secondary switchover feature. The time can range from the current time to 23:59:59 seven days later. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time must be in UTC.'."\n" ."\n" .'> This parameter takes effect only when you set the **HAConfig** parameter to **Manual**.'."\n", 'type' => 'string', 'required' => false, 'example' => '2019-08-29T15:00:00Z', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'B6AE1448-D846-4831-B1C7-CFF3E99D5470', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'HaConfig.Format', 'errorMessage' => 'The value of HaConfig must be auto or manual', ], [ 'errorCode' => 'HaConfigIsNull', 'errorMessage' => 'HaConfig is null.', ], [ 'errorCode' => 'ManualHATime.Format', 'errorMessage' => 'Invalid format of ManualHATime.', ], [ 'errorCode' => 'ManualHATimeIsNull', 'errorMessage' => 'ManualHATime can not be null when the value of haConfig is Manual.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B6AE1448-D846-4831-B1C7-CFF3E99D5470\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n B6AE1448-D846-4831-B1C7-CFF3E99D5470\\r\\n","errorExample":""}]', 'title' => 'ModifyHASwitchConfig', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" .'* MariaDB'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> Before you call this operation, read the following documentation and make sure that you fully understand the prerequisites and impacts of this operation.'."\n" ."\n" .'* [Use the automatic primary/secondary switchover feature for an ApsaraDB RDS for MySQL instance](~~96054~~)'."\n" .'* [Use the automatic primary/secondary switchover feature for an ApsaraDB RDS for PostgreSQL instance](~~96747~~)'."\n" .'* [Use the automatic primary/secondary switchover feature for an ApsaraDB RDS for SQL Server instance](~~95659~~)'."\n" .'* [Use the automatic primary/secondary switchover feature for an ApsaraDB RDS for MariaDB instance](~~97127~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeDBInstanceHAConfig' => [ 'summary' => 'Queries the high availability mode and data replication mode of an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-uf6wjk5xxxxxx', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'DBInstanceId' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5xxxxxx', ], 'HAMode' => [ 'description' => 'The high availability mode of the instance. Valid values:'."\n" ."\n" .'* **RPO**: Data consistency is preferred. The instance ensures data reliability to minimize data losses. If you have high requirements on data consistency, select this mode.'."\n" .'* **RTO**: Service availability is preferred. The instance restores the database service at the earliest opportunity to ensure service availability. If you have high requirements on instance availability, select this mode.'."\n" ."\n" .'> This parameter is returned only for instances that run MySQL.'."\n", 'type' => 'string', 'example' => 'RPO', ], 'HostInstanceInfos' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'NodeInfo' => [ 'description' => 'An array that consists of the information of the primary and secondary instances.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'DataSyncTime' => [ 'description' => 'The time when the secondary instance completed the synchronization of data from the primary instance. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2018-05-05T15:15:00Z', ], 'LogSyncTime' => [ 'description' => 'The time when the secondary instance received logs from the primary instance. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2018-05-05T15:15:00Z', ], 'NodeId' => [ 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => '3397027', ], 'NodeType' => [ 'description' => 'The type of the node. Valid values:'."\n" ."\n" .'* **Master**: the primary node'."\n" .'* **Slave**: the secondary node'."\n", 'type' => 'string', 'example' => 'Master', ], 'RegionId' => [ 'description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], 'SyncStatus' => [ 'description' => 'The synchronization status. Valid values:'."\n" ."\n" .'* **NotAvailable**: The synchronization fails. This means that faults occur.'."\n" .'* **Syncing**: The synchronization is in process. In this case, a primary/secondary switchover may cause data losses.'."\n" .'* **Synchronized**: The synchronization is completed.'."\n" .'* **NotSupport**: The database engine or database engine version does not involve the synchronization between the primary and secondary instances.'."\n", 'type' => 'string', 'example' => 'NotAvailable', ], 'ZoneId' => [ 'description' => 'The ID of the zone.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou-b', ], ], ], ], ], ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', ], 'SyncMode' => [ 'description' => 'The data replication mode of the instance. Valid values:'."\n" ."\n" .'* **Sync**: the synchronous mode'."\n" .'* **Semi-sync**: the semi-synchronous replication mode'."\n" .'* **Async**: the asynchronous mode'."\n" ."\n" .'> This parameter is returned only for instances that run MySQL.'."\n", 'type' => 'string', 'example' => 'Sync', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidConfigName', 'errorMessage' => 'The ConfigName is not valid.', ], [ 'errorCode' => 'IncorrectEngineVersion', 'errorMessage' => 'Current DB instance engine version does not support this operation.', ], [ 'errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'Specified parameter is not valid', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance engine and type does not support operations.', ], [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', ], [ 'errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance does not exist or is not supported.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBInstanceId\\": \\"rm-uf6wjk5****\\",\\n \\"HAMode\\": \\"RPO\\",\\n \\"HostInstanceInfos\\": {\\n \\"NodeInfo\\": [\\n {\\n \\"DataSyncTime\\": \\"2018-05-05T15:15:00Z\\",\\n \\"LogSyncTime\\": \\"2018-05-05T15:15:00Z\\",\\n \\"NodeId\\": \\"3397027\\",\\n \\"NodeType\\": \\"Master\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"SyncStatus\\": \\"NotAvailable\\",\\n \\"ZoneId\\": \\"cn-hangzhou-b\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"SyncMode\\": \\"Sync\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"7463B73D-35CC-4D19-A010-6B8D65D242EF\\",\\n \\"HostId\\": \\"rds.aliyuncs.com\\",\\n \\"Code\\": \\"UnsupportedOperation\\",\\n \\"Message\\": \\"The specified action is not supported.\\"\\n}"},{"type":"xml","example":"\\n103D4ACC-F2F9-4A7E-9ACC-14B0A25613E0\\nrm-uf6wjk5xxxxxx\\nRPO\\n\\n \\n \\n cn-hangzhou-h\\n \\n Slave\\n 13567431\\n NotSupport\\n cn-hangzhou\\n \\n \\n \\n cn-hangzhou-h\\n \\n Master\\n 14565107\\n NotSupport\\n cn-hangzhou\\n \\n\\nSemi-sync\\n","errorExample":""}]', 'title' => 'DescribeDBInstanceHAConfig', 'description' => '### Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" ."\n" .'### References'."\n" ."\n" .'> Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.'."\n" ."\n" .'* [Query the data replication mode of an ApsaraDB RDS for MySQL instance](~~96055~~)'."\n" .'* [Query the data replication mode of an ApsaraDB RDS for PostgreSQL instance](~~151265~~)'."\n" .'* [Query the data replication mode of an ApsaraDB RDS for SQL Server instance](~~415433~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeHASwitchConfig' => [ 'summary' => 'Queries the settings of the automatic primary/secondary switchover feature for an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5xxxxxxxxxx', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'HAConfig' => [ 'description' => 'The status of the automatic primary/secondary switchover feature. Valid values:'."\n" ."\n" .'* **Auto:** The automatic primary/secondary switchover feature is enabled. The system automatically switches your workloads over from the instance to its secondary instance in the event of a fault.'."\n" .'* **Manual:** The automatic primary/secondary switchover feature is temporarily disabled.'."\n", 'type' => 'string', 'example' => 'Manual', ], 'ManualHATime' => [ 'description' => 'The time when the automatic primary/secondary switchover feature is enabled again. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2019-08-29T15:00:00Z', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '4FDF4B79-2741-4C5F-8C76-4B953FC5C2B1', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HAConfig\\": \\"Manual\\",\\n \\"ManualHATime\\": \\"2019-08-29T15:00:00Z\\",\\n \\"RequestId\\": \\"4FDF4B79-2741-4C5F-8C76-4B953FC5C2B1\\"\\n}","type":"json"}]', 'title' => 'DescribeHASwitchConfig', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" .'* MariaDB'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'SwitchDBInstanceHA' => [ 'summary' => 'Switches workloads between primary and secondary ApsaraDB RDS instances.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5xxxxxxxxxx', ], ], [ 'name' => 'NodeId', 'in' => 'query', 'schema' => [ 'description' => 'The secondary instance ID. You can call the DescribeDBInstanceHAConfig operation to query the secondary instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '349054', ], ], [ 'name' => 'Force', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable forcible switching. Valid values:'."\n" ."\n" .'* **Yes**'."\n" .'* **No**'."\n" ."\n" .'Default value: **No**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'No', 'default' => 'No', ], ], [ 'name' => 'EffectiveTime', 'in' => 'query', 'schema' => [ 'description' => 'The time when the switching takes effect. Valid values:'."\n" ."\n" .'* **Immediate**: The switching immediately takes effect.'."\n" .'* **MaintainTime**: The switching takes effect during the maintenance time.'."\n" ."\n" .'Default value: **Immediate**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Immediate', 'default' => 'Immediate', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'GeneralIns.Creating', 'errorMessage' => 'The general instance is creating.', ], [ 'errorCode' => 'GeneralIns.Maintaining', 'errorMessage' => 'The general instance is maintaining.', ], [ 'errorCode' => 'GeneralIns.Switching', 'errorMessage' => 'The general instance is Switching.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC\\"\\n}","type":"json"}]', 'title' => 'SwitchDBInstanceHA', 'description' => '### Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" .'* MariaDB'."\n" ."\n" .'### References'."\n" ."\n" .'> Before you call this operation, read the following documentation and make sure that you fully understand the prerequisites and impacts of this operation.'."\n" ."\n" .'* [Switch workloads between primary and secondary ApsaraDB RDS for MySQL instances](~~96054~~)'."\n" .'* [Switch workloads between primary and secondary ApsaraDB RDS for PostgreSQL instances](~~96747~~)'."\n" .'* [Switch workloads between primary and secondary ApsaraDB RDS for SQL Server instances](~~95659~~)'."\n" .'* [Switch workloads between primary and secondary ApsaraDB RDS for MariaDB instances](~~97127~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ModifyActionEventPolicy' => [ 'summary' => 'Enables or disables the event history feature of an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'EnableEventLog', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable the event history feature. Valid values:'."\n" ."\n" .'* **True**'."\n" .'* **False**'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'True', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'EnableEventLog' => [ 'description' => 'Indicates whether the event history feature is enabled.'."\n", 'type' => 'string', 'example' => 'True', ], 'RegionId' => [ 'description' => 'The ID of the region for which the event history feature is enabled or disabled.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'BAC0952C-0EB3-4DE7-A567-B83269BFE43F', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'RegionNotSupport', 'errorMessage' => 'The region is not supported.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidRegion.NotFound', 'errorMessage' => 'Specified Region does not exist in RDS.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"EnableEventLog\\": \\"True\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"RequestId\\": \\"BAC0952C-0EB3-4DE7-A567-B83269BFE43F\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n BAC0952C-0EB3-4DE7-A567-B83269BFE43F\\r\\n cn-hangzhou\\r\\n True\\r\\n","errorExample":""}]', 'title' => 'ModifyActionEventPolicy', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" .'* MariaDB'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> Before you call this operation, read the following documentation and make sure that you fully understand the prerequisites and impacts of this operation.'."\n" ."\n" .'* [View the event history of an ApsaraDB RDS for MySQL instance](~~129759~~)'."\n" .'* [View the event history of an ApsaraDB RDS for PostgreSQL instance](~~131008~~)'."\n" .'* [View the event history of an ApsaraDB RDS for SQL Server instance](~~131013~~)'."\n" .'* [View the event history of an ApsaraDB RDS for MariaDB instance](~~131010~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeEvents' => [ 'summary' => 'Queries historical events of an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => 'The start of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => false, 'example' => '2019-06-11T15:00:00Z', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => 'The end of the time range to query. The end time must be later than the start time. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => false, 'example' => '2019-06-12T15:00:00Z', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page. Valid values:'."\n" ."\n" .'* **30**'."\n" .'* **50**'."\n" .'* **100**'."\n" ."\n" .'Default value: **30**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => 'The page number. Pages start from page 1.'."\n" ."\n" .'Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'EventItems' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'EventItems' => [ 'description' => 'The events.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'CallerUid' => [ 'description' => 'The ID of the user who executed the event.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '22973492**********', ], 'EventId' => [ 'description' => 'The event ID.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '11000053', ], 'EventName' => [ 'description' => 'The event name.'."\n", 'type' => 'string', 'example' => 'ModifySecurityIPList', ], 'EventPayload' => [ 'description' => 'The request or context parameters of the event.'."\n", 'type' => 'string', 'example' => '{\\"Domain\\": \\"rds-inc-share.aliyuncs.com\\", \\"Api\\": \\"ReleaseInstancePublicConnection\\"}', ], 'EventReason' => [ 'description' => 'The source of the event.'."\n", 'type' => 'string', 'example' => 'FROM_USER', ], 'EventRecordTime' => [ 'description' => 'The time when the event was recorded. The time is slightly later than the time the event occurred.'."\n", 'type' => 'string', 'example' => '2019-08-20T01:12:49Z', ], 'EventTime' => [ 'description' => 'The time when the event occurred.'."\n", 'type' => 'string', 'example' => '2019-08-20T01:08:22Z', ], 'EventType' => [ 'description' => 'The event type.'."\n", 'type' => 'string', 'example' => 'NetworkManagement', ], 'EventUserType' => [ 'description' => 'The type of the user who executed the event.'."\n", 'type' => 'string', 'example' => 'SYSTEM', ], 'RegionId' => [ 'description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], 'ResourceName' => [ 'description' => 'The name of the resource associated with the event. Only instance IDs are supported for this parameter.'."\n", 'type' => 'string', 'example' => 'rm-bp1z3065m9976ix8a', ], 'ResourceType' => [ 'description' => 'The type of the resource associated with the event. Only instances are supported for this parameter.'."\n", 'type' => 'string', 'example' => 'instance', ], ], ], ], ], ], 'PageNumber' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'A103039D-B1B2-4C57-B989-7D7C0DA95426', ], 'TotalRecordCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '40', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidStartTime.Format', 'errorMessage' => 'Specified start time is not valid.', ], [ 'errorCode' => 'InvalidParameterCombination', 'errorMessage' => 'The end time must be greater than the start time', ], [ 'errorCode' => 'RegionNotSupport', 'errorMessage' => 'The region is not supported.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidRegion.NotFound', 'errorMessage' => 'Specified Region does not exist in the RDS', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"EventItems\\": {\\n \\"EventItems\\": [\\n {\\n \\"CallerUid\\": 0,\\n \\"EventId\\": 11000053,\\n \\"EventName\\": \\"ModifySecurityIPList\\",\\n \\"EventPayload\\": \\"{\\\\\\\\\\\\\\"Domain\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"rds-inc-share.aliyuncs.com\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"Api\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"ReleaseInstancePublicConnection\\\\\\\\\\\\\\"}\\",\\n \\"EventReason\\": \\"FROM_USER\\",\\n \\"EventRecordTime\\": \\"2019-08-20T01:12:49Z\\",\\n \\"EventTime\\": \\"2019-08-20T01:08:22Z\\",\\n \\"EventType\\": \\"NetworkManagement\\",\\n \\"EventUserType\\": \\"SYSTEM\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ResourceName\\": \\"rm-bp****\\",\\n \\"ResourceType\\": \\"instance\\"\\n }\\n ]\\n },\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"RequestId\\": \\"A103039D-B1B2-4C57-B989-7D7C0DA95426\\",\\n \\"TotalRecordCount\\": 40\\n}","errorExample":""},{"type":"xml","example":"\\n \\n \\n ModifySecurityIPList\\n SYSTEM\\n instance\\n \\n 2019-08-20T01:33:43Z\\n cn-hangzhou\\n 2019-08-20T01:33:57Z\\n FROM_SYSTEM\\n 11000048\\n rm-bpxxxxxxx\\n SecurityManagement\\n 25421491**********\\n \\n \\n ModifySecurityIPList\\n SYSTEM\\n instance\\n \\n 2019-08-20T01:33:43Z\\n cn-hangzhou\\n 2019-08-20T01:33:57Z\\n FROM_SYSTEM\\n 11000047\\n rm-bpxxxxxxx\\n SecurityManagement\\n 22973492**********\\n \\n \\n 2\\n 1\\n 2\\n B5FF9EE6-830E-4DBE-8498-9890A62D2875\\n","errorExample":""}]', 'title' => 'DescribeEvents', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" .'* MariaDB'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> Before you call this operation, read the following documentation and make sure that you fully understand the prerequisites and impacts of this operation.'."\n" ."\n" .'* [Historical events of an ApsaraDB RDS for MySQL instance](~~129759~~)'."\n" .'* [Historical events of an ApsaraDB RDS for PostgreSQL instance](~~131008~~)'."\n" .'* [Historical events of an ApsaraDB RDS for SQL Server instance](~~131013~~)'."\n" .'* [Historical events of an ApsaraDB RDS for MariaDB instance](~~131010~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeActionEventPolicy' => [ 'summary' => 'Queries whether the historical events feature is enabled.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The resource group ID. You can call the DescribeDBInstanceAttribute to query the resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy*****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'EnableEventLog' => [ 'description' => 'Indicates whether the event history feature is enabled.'."\n", 'type' => 'string', 'example' => 'True', ], 'RegionId' => [ 'description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'CCECD3CD-AB2D-4F6D-BEDE-47BC90A398D2', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'RegionNotSupport', 'errorMessage' => 'The region does not support.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidRegion.NotFound', 'errorMessage' => 'Specified Region does not exist in RDS.', ], [ 'errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'Specified user does not exist.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"EnableEventLog\\": \\"True\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"RequestId\\": \\"CCECD3CD-AB2D-4F6D-BEDE-47BC90A398D2\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\nCCECD3CD-AB2D-4F6D-BEDE-47BC90A398D2\\r\\n\\tcn-hangzhou\\r\\n\\tTrue\\r\\n ","errorExample":""}]', 'title' => 'DescribeActionEventPolicy', 'description' => '### Supported database engines'."\n" ."\n" .'* RDS MySQL'."\n" .'* RDS PostgreSQL'."\n" .'* RDS SQL Server'."\n" .'* RDS MariaDB'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'QueryNotify' => [ 'summary' => 'Queries the notifications of an ApsaraDB RDS instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'WithConfirmed', 'in' => 'formData', 'schema' => [ 'description' => 'Specifies whether the query results contain confirmed notifications. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n" ."\n" .'> A confirmed notification is a notification that has been marked as confirmed by calling the ConfirmNotify operation.'."\n", 'type' => 'boolean', 'required' => true, 'example' => 'false', ], ], [ 'name' => 'From', 'in' => 'formData', 'schema' => [ 'description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => true, 'example' => '2022-05-02T08:38:37Z', ], ], [ 'name' => 'To', 'in' => 'formData', 'schema' => [ 'description' => 'The end of the time range to query. The end time must be later than the start time. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => true, 'example' => '2022-05-09T08:38:37Z', ], ], [ 'name' => 'PageSize', 'in' => 'formData', 'schema' => [ 'description' => 'The number of entries per page. Valid values:'."\n" ."\n" .'* **30**'."\n" .'* **50**'."\n" .'* **100**'."\n" ."\n" .'Default value: **30**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '30', 'default' => '30', ], ], [ 'name' => 'PageNumber', 'in' => 'formData', 'schema' => [ 'description' => 'The page number. Pages start from page 1. Default value: 1.****'."\n" ."\n" .'Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResponse', 'description' => 'PlainResponse'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'NotifyItemList' => [ 'description' => 'The details of notifications.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'AliUid' => [ 'description' => 'The ID of the Alibaba Cloud account.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '22973492**********', ], 'ConfirmFlag' => [ 'description' => 'Indicates whether the notification has been confirmed. You can call the [ConfirmNotify](~~610444~~) operation to mark the notification as confirmed. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Confirmor' => [ 'description' => 'The UID of the contact who called the [ConfirmNotify](~~610444~~) operation to mark the notification as confirmed. The contact belongs to the current Alibaba Cloud account.'."\n" ."\n" .'The value **0** indicates that the notification is automatically confirmed by the system.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'GmtCreated' => [ 'description' => 'The time when the notification was created.'."\n", 'type' => 'string', 'example' => '2022-04-21T02:04:04Z', ], 'GmtModified' => [ 'description' => 'The time when the notification was modified.'."\n", 'type' => 'string', 'example' => '2022-04-21T02:10:47Z', ], 'Id' => [ 'description' => 'The ID of the notification.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '103499', ], 'IdempotentCount' => [ 'description' => 'The number of times that repeatedly sent notifications are blocked.'."\n", 'type' => 'string', 'example' => '0', ], 'IdempotentId' => [ 'description' => 'This parameter ensures the idempotence of the notification and prevents the notification from being repeatedly sent.'."\n", 'type' => 'string', 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxxxxx', ], 'Level' => [ 'description' => 'The level of the notification. Valid values:'."\n" ."\n" .'* **help**'."\n" .'* **success**'."\n" .'* **warning**'."\n" .'* **error**'."\n" .'* **loading**'."\n" .'* **notice**'."\n", 'type' => 'string', 'example' => 'error', ], 'NotifyElement' => [ 'description' => 'The element in the notification template. This parameter is a JSON string. Fields in the JSON string vary based on the value of the **TemplateName** parameter.'."\n" ."\n" .'* If the **TemplateName** parameter is **RenewalRecommend**, the JSON string contains the following fields:'."\n" ."\n" .' * **instanceName**: the ID of the instance that is about to expire'."\n" .' * **reservedTime**: the remaining validity period of the instance in days'."\n" ."\n" .'* If the **TemplateName** parameter is **InstanceCreateFailed**, the JSON string contains the following fields:'."\n" ."\n" .' * **orderId**: the ID of the order to purchase the instance'."\n" .' * **reason**: the cause of the instance creation failure'."\n", 'type' => 'string', 'example' => '{\\"orderId\\":21466**********}', ], 'TemplateName' => [ 'description' => 'The template of the notification. Valid values:'."\n" ."\n" .'* **RenewalRecommend**: The template that is used to notify of renewal suggestions.'."\n" .'* **InstanceCreateFailed**: The template that is used to notify that an instance fails to be created and is refunded.'."\n", 'type' => 'string', 'example' => 'InstanceCreateFailed', ], 'Type' => [ 'description' => 'The type of the notification. Valid values:'."\n" ."\n" .'* **Sell**: sales notification'."\n" .'* **Operation**: O\\&M notification'."\n" .'* **Promotion**: promotion notification'."\n", 'type' => 'string', 'example' => 'Sell', ], ], ], ], 'PageNumber' => [ 'description' => 'The page number of the page returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned on each page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '25', ], 'TotalRecordCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '94CB8D93-017A-5AE7-A118-6E0F89D93C0A', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Param.Invalid', 'errorMessage' => 'Param invalid', ], [ 'errorCode' => 'Param.Invalid.TimeEndBeforeStart', 'errorMessage' => 'Param invalid. End time before start time', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": {\\n \\"NotifyItemList\\": [\\n {\\n \\"AliUid\\": 0,\\n \\"ConfirmFlag\\": true,\\n \\"Confirmor\\": 0,\\n \\"GmtCreated\\": \\"2022-04-21T02:04:04Z\\",\\n \\"GmtModified\\": \\"2022-04-21T02:10:47Z\\",\\n \\"Id\\": 103499,\\n \\"IdempotentCount\\": \\"0\\",\\n \\"IdempotentId\\": \\"ETnLKlblzczshOTUbOCz****\\",\\n \\"Level\\": \\"error\\",\\n \\"NotifyElement\\": \\"{\\\\\\\\\\\\\\"orderId\\\\\\\\\\\\\\":21466****}\\",\\n \\"TemplateName\\": \\"InstanceCreateFailed\\",\\n \\"Type\\": \\"Sell\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 25,\\n \\"TotalRecordCount\\": 1\\n },\\n \\"RequestId\\": \\"94CB8D93-017A-5AE7-A118-6E0F89D93C0A\\"\\n}","errorExample":""},{"type":"xml","example":"\\n \\n \\n 103499\\n 2022-04-21T02:04:04Z\\n 2022-04-21T02:10:47Z\\n ETnLKlblzczshOTUbOCzxxxxxxxxxx\\n 0\\n Sell\\n error\\n InstanceCreateFailed\\n {\\\\\\"orderId\\\\\\":21466**********}\\n true\\n 0\\n \\n 25\\n 1\\n 1\\n \\n 94CB8D93-017A-5AE7-A118-6E0F89D93C0A\\n","errorExample":""}]', 'title' => 'QueryNotify', 'description' => '### Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" .'* MariaDB'."\n" ."\n" .'### Feature description'."\n" ."\n" .'The notifications are highlighted at the top of the ApsaraDB RDS console. The notifications include renewal reminders and reminders of instance creation failures.'."\n" ."\n" .'After you call this operation to query notifications, you can call the [ConfirmNotify](~~610444~~) operation to mark the notifications as confirmed, which means that you understand the content of the notifications.'."\n", ], 'ConfirmNotify' => [ 'summary' => 'Marks the notifications of an instance within your Alibaba Cloud account as confirmed.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'Confirmor', 'in' => 'formData', 'schema' => [ 'description' => 'The ID of the Alibaba Cloud account that is used to confirm the notification. You can set this parameter to **0**, which indicates that the notification is confirmed by the system.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => false, 'example' => '0', ], ], [ 'name' => 'NotifyIdList', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'The notification IDs.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The ID of the notification that needs to be confirmed. You can call the QueryNotify operation to query the notification ID for an instance.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '100000', ], 'required' => true, 'maxItems' => 100, 'minItems' => 1, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'BaseResponse', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '6919FA39-04CF-571F-A6B0-DCC7AECB4170', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidNotifyId', 'errorMessage' => 'No auth to confirm record', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6919FA39-04CF-571F-A6B0-DCC7AECB4170\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 6919FA39-04CF-571F-A6B0-DCC7AECB4170\\n","errorExample":""}]', 'title' => 'ConfirmNotify', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" .'* MariaDB'."\n" ."\n" .'### [](#)Feature description'."\n" ."\n" .'After you call the [QueryNotify](~~610443~~) operation to query notifications for an instance, you can call this operation to mark the notifications as confirmed.'."\n", ], 'DescribeRdsResourceSettings' => [ 'summary' => 'Obtains the notification settings for instance resources. This operation can still be called but is no longer maintained.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => true, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'ResourceNiche', 'in' => 'query', 'schema' => [ 'description' => 'The location of the notification.'."\n" ."\n" .'* noticeBar: notification bar'."\n" .'* popUp: popup'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'enumValueTitles' => [ 'noticeBar' => 'noticeBar', 'popUp' => 'popUp', ], 'example' => 'noticeBar', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RdsInstanceResourceSettings' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'RdsInstanceResourceSetting' => [ 'description' => 'The details about notification settings for an instance.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'EndDate' => [ 'description' => 'The end date.'."\n", 'type' => 'string', 'example' => '2024-04-25', ], 'IsTop' => [ 'description' => 'Specifies whether to pin the notification at the top.'."\n" ."\n" .'* true'."\n" .'* false'."\n", 'type' => 'string', 'example' => 'true', ], 'NoticeBarContent' => [ 'description' => 'The notification text.'."\n", 'type' => 'string', 'example' => '', ], 'PoppedUpButtonText' => [ 'description' => 'The text of the popup button.'."\n", 'type' => 'string', 'example' => '', ], 'PoppedUpButtonType' => [ 'description' => 'The type of the popup button.'."\n" ."\n" .'* BUY'."\n" .'* RENEW'."\n" .'* UPGRADE'."\n", 'type' => 'string', 'example' => '', ], 'PoppedUpButtonUrl' => [ 'description' => 'The link of the popup button.'."\n", 'type' => 'string', 'example' => 'https://www.example.com/subscribe', ], 'PoppedUpContent' => [ 'description' => 'The text of the popup.'."\n", 'type' => 'string', 'example' => '', ], 'ResourceNiche' => [ 'description' => 'The location of the notification.'."\n", 'type' => 'string', 'example' => '', ], 'StartDate' => [ 'description' => 'The effective date.'."\n", 'type' => 'string', 'example' => '2024-04-21', ], ], 'description' => '', ], ], ], ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '76364A52-E0AB-5CC8-xxxx-CF1DC482C092', ], ], 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'staticInfo' => [ 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RdsInstanceResourceSettings\\": {\\n \\"RdsInstanceResourceSetting\\": [\\n {\\n \\"EndDate\\": \\"2024-04-25\\",\\n \\"IsTop\\": \\"true\\",\\n \\"NoticeBarContent\\": \\"系统将于今晚十点进行维护，届时可能会短暂影响服务。\\",\\n \\"PoppedUpButtonText\\": \\"立即订阅。\\",\\n \\"PoppedUpButtonType\\": \\"新购：BUY\\",\\n \\"PoppedUpButtonUrl\\": \\"https://www.example.com/subscribe\\",\\n \\"PoppedUpContent\\": \\"获得最新更新和新闻，通过订阅我们的通知，确保您永远不会错过任何重要消息。\\",\\n \\"ResourceNiche\\": \\"noticeBar（通知栏）\\",\\n \\"StartDate\\": \\"2024-04-21\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"76364A52-E0AB-5CC8-xxxx-CF1DC482C092\\"\\n}","type":"json"}]', 'title' => 'DescribeRdsResourceSettings', 'description' => 'This operation can still be called but is no longer maintained.'."\n", ], 'CreateAccount' => [ 'summary' => 'Creates a database account.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5xxxxxxx', ], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the database account.'."\n" ."\n\n" .'* The name must be unique.'."\n" ."\n" .'* The name can contain lowercase letters, digits, and underscores (\\_). For MySQL databases, the name can contain uppercase letters.'."\n" ."\n" .'* The name must start with a letter and end with a letter or digit.'."\n" ."\n" .'* For MySQL databases, the name of the privileged account cannot be the same as that of the standard account. For example, if the name of the privileged account is `Test1`, the name of the standard account cannot be `test1`.'."\n" ."\n" .'* The length of the value must meet the following requirements:'."\n" ."\n" .' * If the instance runs MySQL 5.7 or MySQL 8.0, the value must be 2 to 32 characters in length.'."\n" .' * If the instance runs MySQL 5.6, the value must be 2 to 16 characters in length.'."\n" .' * If the instance runs SQL Server, the value must be 2 to 64 characters in length.'."\n" .' * If the instance runs PostgreSQL with cloud disks, the value must be 2 to 63 characters in length.'."\n" .' * If the instance runs PostgreSQL with local disks, the value must be 2 to 16 characters in length.'."\n" .' * If the instance runs MariaDB, the value must be 2 to 16 characters in length.'."\n" ."\n" .'* For more information about invalid characters, see [Forbidden keywords](~~26317~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test1', ], ], [ 'name' => 'AccountPassword', 'in' => 'query', 'schema' => [ 'description' => 'The password of the account.'."\n" .' '."\n" ."\n" .'* The value must be 8 to 32 characters in length.'."\n" ."\n" .'* The password must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters.'."\n" ."\n" .'* Special characters include `! @ # $ % ^ & * ( ) _ + - =`', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Test123456', ], ], [ 'name' => 'AccountDescription', 'in' => 'query', 'schema' => [ 'description' => 'The description of the account. The value must be 2 to 256 characters in length. The value can contain letters, digits, underscores (\\_), and hyphens (-), and must start with a letter.'."\n" ."\n" .'> : The name cannot start with http:// or https://.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Test Account A'."\n", ], ], [ 'name' => 'AccountType', 'in' => 'query', 'schema' => [ 'description' => 'The account type. Valid values:'."\n" ."\n" .'* **Normal** (default): standard account.'."\n" .'* **Super**: privileged account.'."\n" .'* **Sysadmin**: system admin account. The account type is available only for ApsaraDB RDS for SQL Server instances.'."\n" ."\n" .'Before you create a system admin account, check whether the instance meets all prerequisites. For more information, see [Create a system admin account](~~170736~~).'."\n", 'type' => 'string', 'required' => false, 'example' => 'Normal', 'default' => 'Normal', ], ], [ 'name' => 'CheckPolicy', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to use a password policy.'."\n" ."\n" .'> '."\n" ."\n" .'* This parameter is available only for ApsaraDB RDS for SQL Server instances that do not belong to the shared instance family and do not run SQL Server 2008 R2.'."\n" ."\n" .'* Before you call this operation, you must configure a password policy for the account of your instance. For more information, see [Configure a password policy for the account of an ApsaraDB RDS for SQL Server instance](~~2848317~~).'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'D4D4BE8A-DD46-440A-BFCD-EE31DA81C9DD', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'GeneralIns.Creating', 'errorMessage' => 'The general instance is creating.', ], [ 'errorCode' => 'GeneralIns.Maintaining', 'errorMessage' => 'The general instance is maintaining.', ], [ 'errorCode' => 'GeneralIns.Switching', 'errorMessage' => 'The general instance is Switching.', ], [ 'errorCode' => 'InvalidEngineVersion.NotSupported', 'errorMessage' => 'Current db instance does not support sysadmin.', ], [ 'errorCode' => 'Database.ConnectError', 'errorMessage' => 'Database connect error. please check instance status and database processlist', ], [ 'errorCode' => 'Account.AddError', 'errorMessage' => 'Create Account failed, please check your input value or may your input value not satisfy instance current policy', ], [ 'errorCode' => 'InvalidAccountPassword.Format', 'errorMessage' => 'Specified account password is not valid.', ], [ 'errorCode' => 'InvalidAccountDescription.Format', 'errorMessage' => 'Specified account description is not valid.', ], [ 'errorCode' => 'InvalidGeneralGroupNameOrGdnInstanceName', 'errorMessage' => 'The specified params generalGroupName or gdnInstanceName should not be null.', ], [ 'errorCode' => 'InvalidAccountPrivilege.Malformed', 'errorMessage' => 'Specified account privilege is not valid.', ], [ 'errorCode' => 'InvalidAccountName.Forbid', 'errorMessage' => 'Specified account name is a keyword in RDS.', ], [ 'errorCode' => 'InvalidDBDescription.Format', 'errorMessage' => 'Specified DB description is not valid.', ], [ 'errorCode' => '%s', 'errorMessage' => 'DB Operation Failed:%s.', ], [ 'errorCode' => 'InvalidAccountType.Format', 'errorMessage' => 'The first account can\'t be normal type.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'Account.QueryError', 'errorMessage' => 'Query Account failed, please check your input value.', ], [ 'errorCode' => 'InvalidConnectionInfo', 'errorMessage' => 'Specified ConnectionInfo is not valid.', ], [ 'errorCode' => 'InvalidCharacter.DbOrAccount', 'errorMessage' => 'The database name or account name contains invalid characters.', ], [ 'errorCode' => 'InstanceAccountSameWithOsAccount', 'errorMessage' => 'The instance account name cannot be the same as the OS account name.', ], [ 'errorCode' => 'InvalidDBName.Duplicate', 'errorMessage' => 'Specified DB name already exists in the This instance.', ], [ 'errorCode' => 'GlobalReadonlyAccountMaxCountExceed', 'errorMessage' => 'The number of global read-only accounts exceeds the limit.', ], ], 403 => [ [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', ], [ 'errorCode' => 'IncorrectAccountType', 'errorMessage' => 'Current account type does not support this operation.', ], [ 'errorCode' => 'AccountLimitExceeded', 'errorMessage' => 'AccountQuotaExceeded: Exceeding the allowed amount of account', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', ], [ 'errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D4D4BE8A-DD46-440A-BFCD-EE31DA81C9DD\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"7463B73D-35CC-4D19-A010-6B8D65D242EF\\",\\n \\"HostId\\": \\"rds.aliyuncs.com\\",\\n \\"Code\\": \\"UnsupportedOperation\\",\\n \\"Message\\": \\"The specified action is not supported.\\"\\n}"},{"type":"xml","example":"\\n D4D4BE8A-DD46-440A-BFCD-EE31DA81C9DD\\n","errorExample":""}]', 'title' => 'CreateAccount', 'description' => '### Supported database engines'."\n" ."\n" .'* RDS MySQL'."\n" .'* RDS PostgreSQL'."\n" .'* RDS SQL Server'."\n" .'* RDS MariaDB'."\n" ."\n" .'### References'."\n" ."\n" .'> : Before you call this operation, read the following documentation and make sure that you fully understand the prerequisites and impacts of this operation.'."\n" ."\n" .'* [Create an account on an ApsaraDB RDS for MySQL instance](~~96089~~)'."\n" .'* [Create an account on an ApsaraDB RDS for PostgreSQL instance](~~96753~~)'."\n" .'* [Create an account on an ApsaraDB RDS for SQL Server instance](~~95810~~)'."\n" .'* [Create an account on an ApsaraDB RDS for MariaDB instance](~~97132~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DeleteAccount' => [ 'summary' => 'Deletes an account from an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'high', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-uf6wjk5****', ], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the account.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '91E855E5-7E80-4955-929B-C74EE1D38C66', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => '%s', 'errorMessage' => 'DB Operation Failed:%s.', ], [ 'errorCode' => 'Database.ConnectError', 'errorMessage' => 'Database connect error. please check instance status and database processlist', ], [ 'errorCode' => 'GdnRole.NotSupport', 'errorMessage' => 'Specified gdn role is not support.', ], [ 'errorCode' => 'IncorrectAccountStatus', 'errorMessage' => 'Current account status does not support this operation.', ], [ 'errorCode' => 'Account.DeleteError', 'errorMessage' => 'Failed to delete the account. Parameter values are invalid, or the request is waiting for locks.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'DbossGeneralError', 'errorMessage' => 'The instance is being created. Please wait.', ], [ 'errorCode' => 'InvalidCharacter.DbOrAccount', 'errorMessage' => 'The database name or account name contains invalid characters.', ], [ 'errorCode' => 'Account.DelError', 'errorMessage' => 'Failed to delete the account. Check the request or the input parameters. Other threads in the instance may be waiting for the lock or the host value of the current database account is not set to % (allows logins from all hosts).', ], ], [ [ 'errorCode' => 'AccountActionForbidden', 'errorMessage' => 'Some objects depend on account.', ], [ 'errorCode' => 'Account.SupabaseAdminRestricted', 'errorMessage' => 'This account is managed by Supabase and is restricted from direct modification. Please use the Supabase Console or API.', ], ], 403 => [ [ 'errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance engine and type does not support operations.', ], [ 'errorCode' => 'IncorrectAccountType', 'errorMessage' => 'Current account type does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstanceCharacterType', 'errorMessage' => 'Current DB Instance character_type does not support this operation.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', ], [ 'errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', ], [ 'errorCode' => 'InvalidAccountName.NotFound', 'errorMessage' => 'Specified account name does not exist.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"91E855E5-7E80-4955-929B-C74EE1D38C66\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 91E855E5-7E80-4955-929B-C74EE1D38C66\\n","errorExample":""}]', 'title' => 'DeleteAccount', 'description' => '### Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" .'* MariaDB'."\n" ."\n" .'### References'."\n" ."\n" .'> Before you call this operation, read the following documentation and make sure that you fully understand the prerequisites and impacts of this operation.'."\n" ."\n" .'* [Delete a database account from an ApsaraDB RDS for MySQL instance](~~96104~~)'."\n" .'* [Delete a database account from an ApsaraDB RDS for PostgreSQL instance](~~147649~~)'."\n" .'* [Delete a database account from an ApsaraDB RDS for SQL Server instance](~~95694~~)'."\n" .'* [Delete a database account from an ApsaraDB RDS for MariaDB instance](~~97135~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ModifyAccountCheckPolicy' => [ 'summary' => 'Checks whether a password policy is applied to an account.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The client token can contain only ASCII characters. If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID may be different for each request.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOC****', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The resource group ID. For more information about resource groups, see related documentation.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy****', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-uf6wjk5xxxxxxxxxx', ], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => [ 'description' => 'The account username.'."\n", 'type' => 'string', 'required' => true, 'example' => 'DatabaseTest', ], ], [ 'name' => 'CheckPolicy', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to apply the password policy'."\n", 'type' => 'boolean', 'required' => true, 'example' => 'true', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request'."\n", 'type' => 'string', 'example' => '866F5EB8-4650-4061-87F0-379F6F968BCE', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"866F5EB8-4650-4061-87F0-379F6F968BCE\\"\\n}","type":"json"}]', 'title' => 'ModifyAccountCheckPolicy', 'description' => '### [](#)Supported database engine'."\n" ."\n" .'* SQL Server'."\n", ], 'ModifyAccountDescription' => [ 'summary' => 'Modifies the description of a database account.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-uf6wjk5xxxxxxx', ], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => [ 'description' => 'The username of the account. You can call the DescribeAccounts operation to obtain the username of the account.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test1', ], ], [ 'name' => 'AccountDescription', 'in' => 'query', 'schema' => [ 'description' => 'The description of the account. The value must be 2 to 256 characters in length. The value can contain letters, digits, underscores (\\_), and hyphens (-), and must start with a letter.'."\n" ."\n" .'> The description cannot start with http:// or https://.'."\n", 'type' => 'string', 'required' => true, 'example' => 'Test Account A'."\n", ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '17F57FEE-EA4F-4337-8D2E-9C23CAA63D74', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => '%s', 'errorMessage' => 'DB Operation Failed:%s.', ], [ 'errorCode' => 'InvalidDBDescription.Format', 'errorMessage' => 'Specified DB description is not valid.', ], [ 'errorCode' => 'Account.UpdateError', 'errorMessage' => 'Account is invalid.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance engine and type does not support operations.', ], [ 'errorCode' => 'IncorrectDBInstanceCharacterType', 'errorMessage' => 'Current DB Instance character_type does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', ], [ 'errorCode' => 'IncorrectAccountType', 'errorMessage' => 'Current account type does not support this operation.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', ], [ 'errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', ], [ 'errorCode' => 'InvalidAccountName.NotFound', 'errorMessage' => 'Specified account name does not exist.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"17F57FEE-EA4F-4337-8D2E-9C23CAA63D74\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"7463B73D-35CC-4D19-A010-6B8D65D242EF\\",\\n \\"HostId\\": \\"rds.aliyuncs.com\\",\\n \\"Code\\": \\"UnsupportedOperation\\",\\n \\"Message\\": \\"The specified action is not supported.\\"\\n}"},{"type":"xml","example":"\\n\\n\\t 17F57FEE-EA4F-4337-8D2E-9C23CAA63D74\\n\\n\\t\\n","errorExample":""}]', 'title' => 'ModifyAccountDescription', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* RDS MySQL'."\n" .'* RDS PostgreSQL'."\n" .'* RDS SQL Server'."\n" .'* RDS MariaDB'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ModifyPGHbaConfig' => [ 'summary' => 'Modifies the pg_hba.conf file of an ApsaraDB RDS for PostgreSQL instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'A reserved parameter. You do not need to specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => '1', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'pgm-bp1lymyn1v3i****', ], ], [ 'name' => 'OpsType', 'in' => 'query', 'schema' => [ 'description' => 'The method that you use to modify the pg_hba.conf file. Valid values:'."\n" ."\n" .'* **add**: adds one or more records. If you use this method, make sure that the value of the PriorityId parameter for each new record is different from the value of the PriorityId parameter for any existing record.'."\n" .'* **delete**: deletes one or more records. If you use this method, the record that corresponds to the specified value of the **PriorityId** parameter is deleted from the pg_hba.conf file.'."\n" .'* **modify**: modifies one or more records. If you use this method, the record that corresponds to the specified value of the **PriorityId** parameter is modified.'."\n" .'* **update**: overwrites the existing configuration in the pg_hba.conf file by using the new configuration.'."\n", 'type' => 'string', 'required' => true, 'example' => 'add', ], ], [ 'name' => 'HbaItem', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'An array that consists of the details of the AD domain services.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Address' => [ 'description' => 'The IP addresses from which the specified users can access the specified databases. If you set this parameter to 0.0.0.0/0, the specified users are allowed to access the specified databases from all IP addresses.'."\n", 'type' => 'string', 'required' => true, 'example' => '0.0.0.0/0', ], 'Database' => [ 'description' => 'The name of the database. If you set this parameter to all, the specified users are allowed to access all databases on the instance.'."\n" ."\n" .'If you specify multiple entries, separate the entries with commas (,).'."\n", 'type' => 'string', 'required' => true, 'example' => 'all', ], 'Mask' => [ 'description' => 'The mask of the IP address. If the value of the **Address** parameter is an IP address, you can use this parameter to specify the mask of the IP address.'."\n", 'type' => 'string', 'required' => false, 'example' => '0', ], 'Method' => [ 'description' => 'The authentication method. Valid values:'."\n" ."\n" .'* **trust**'."\n" .'* **reject**'."\n" .'* **scram-sha-256**'."\n" .'* **md5**'."\n" .'* **password**'."\n" .'* **gss**'."\n" .'* **sspi**'."\n" .'* **ldap**'."\n" .'* **radius**'."\n" .'* **cert**'."\n" .'* **pam**'."\n", 'type' => 'string', 'required' => true, 'example' => 'ldap', ], 'Option' => [ 'description' => 'The options of the authentication method. In this topic, LDAP is used as an example. You must configure this parameter. For more information, see [Authentication Methods](https://www.postgresql.org/docs/11/auth-methods.html).'."\n", 'type' => 'string', 'required' => false, 'example' => 'ldapserver=The private IP address of the ECS instance ldapbasedn="CN=Users,DC=pgsqldomain,DC=net" ldapbinddn="CN=The username of the administrator user of the AD domain controller, CN=Users,DC=pgsqldomain,DC=net" ldapbindpasswd="The password of the administrator user of the AD domain controller" ldapsearchattribute="sAMAccountName"'."\n", ], 'PriorityId' => [ 'description' => 'The priority of the record. If you set this parameter to 0, the record has the highest priority. Valid values: 0 to 10000.'."\n" ."\n" .'This parameter is used to identify each record. When you add a record, the value of the PriorityId parameter for the new record must be different from the value of the PriorityId parameter of any existing record. When you modify or delete a record, you must also modify or delete the value of the PriorityId parameter for this record.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '2', ], 'Type' => [ 'description' => 'The connection type.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'* **host**: The record matches TCP/IP connections, including SSL connections and non-SSL connections.'."\n" .'* **hostssl**: The record matches only TCP/IP connections that are established over SSL.'."\n" .'* **hostnossl**: The record matches only TCP/IP connections that are not established over SSL connections.'."\n" ."\n" .'> You can set this parameter to hostssl only when SSL encryption is enabled for the instance. For more information, see Configure SSL encryption for an ApsaraDB RDS for PostgreSQL instance.[](~~229518~~)'."\n", 'type' => 'string', 'required' => true, 'example' => 'host', ], 'User' => [ 'description' => 'The user who is allowed to access the specified databases. You must specify the user that is used to log on to the RDS instance. If you specify multiple entries, separate the entries with commas (,).'."\n", 'type' => 'string', 'required' => true, 'example' => 'ldapuser', ], ], 'required' => true, ], 'required' => true, 'maxItems' => 1000, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '458E0781-C46C-55F5-A0E5-1DD284B28A3F', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'HbaItem.InvalidType', 'errorMessage' => 'Specified hba item type is invalid.', ], [ 'errorCode' => 'HbaItem.InvalidMethod', 'errorMessage' => 'Specified hba item auth method is invalid.', ], [ 'errorCode' => 'HbaItem.InvalidIPMask', 'errorMessage' => 'Specified hba item ip mask is invalid.', ], [ 'errorCode' => 'HbaItem.InvalidPriority', 'errorMessage' => 'Specified hba item priorityId is out of range or duplicate.', ], [ 'errorCode' => 'HbaItemOpsType.Invalid', 'errorMessage' => 'Specified hba opsType is invalid.', ], [ 'errorCode' => 'InvalidConfigValue', 'errorMessage' => 'The ConfigValue is not valid', ], [ 'errorCode' => 'MinorVersionNotSupport', 'errorMessage' => 'The current database minor version does not support the operation.', ], [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The specified DB instance name does not exist.', ], [ 'errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', ], [ 'errorCode' => 'InvalidIP.Format', 'errorMessage' => 'The specified IP address is illegal or invalid.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'HbaItemPriorityIdAlreadyExist', 'errorMessage' => 'Specified hba item priorityId is exist.', ], [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'HbaItemPriorityIdNotFound', 'errorMessage' => 'Specified hba item priorityId is not found.', ], [ 'errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"458E0781-C46C-55F5-A0E5-1DD284B28A3F\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 458E0781-C46C-55F5-A0E5-1DD284B28A3F\\n","errorExample":""}]', 'title' => 'ModifyPGHbaConfig', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'RDS PostgreSQL'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> : Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.'."\n" ."\n" .'* [Connect an ApsaraDB RDS for PostgreSQL instance to a self-managed AD domain](~~349288~~)'."\n" .'* [The pg_hba.conf File](https://www.postgresql.org/docs/11/auth-pg-hba-conf.html)'."\n", ], 'DescribeAccounts' => [ 'summary' => 'Queries the details about the accounts that are created on an ApsaraDB RDS instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n" ."\n" .'> This parameter is not supported for RDS instances that run SQL Server 2017 on RDS Cluster Edition.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5*****', ], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the database account.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page. Valid values: **30 to 200**. Default value: **30**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '30', 'default' => '500', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => 'The page number. Default value: **1**. Pages start from page 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '0', 'example' => '1', 'default' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Accounts' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'DBInstanceAccount' => [ 'description' => 'The information about the account.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details of the account.'."\n", 'type' => 'object', 'properties' => [ 'AccountDescription' => [ 'description' => 'The description of the account.'."\n", 'type' => 'string', 'example' => 'Test account'."\n", ], 'AccountName' => [ 'title' => '', 'description' => 'The name of the database account.'."\n", 'type' => 'string', 'example' => 'test1', ], 'AccountStatus' => [ 'description' => 'The status of the account. Valid values:'."\n" ."\n" .'* **Unavailable**'."\n" .'* **Available**'."\n", 'type' => 'string', 'example' => 'Available', ], 'AccountType' => [ 'description' => 'The type of the account. Valid values:'."\n" ."\n" .'* **Normal**: standard account'."\n" .'* **Super**: privileged account'."\n" .'* **Sysadmin**: system admin account, which is supported only for instances running SQL Server'."\n", 'type' => 'string', 'example' => 'Normal', ], 'BypassRLS' => [ 'description' => 'Indicates whether the account has the row-level security (RLS) permissions. Valid values:'."\n" ."\n" .'* **t**: The account has the RLS permissions.'."\n" .'* **f**: The account does not have the RLS permissions.'."\n" ."\n" .'> This parameter is returned only for instances that run PostgreSQL.'."\n", 'type' => 'string', 'example' => 'f', ], 'CheckPolicy' => [ 'description' => 'Indicates whether the password policy is applied.'."\n" ."\n" .'> This parameter is returned only for instances that run SQL Server.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'CreateDB' => [ 'description' => 'Indicates whether the account has the permissions to create databases. Valid values:'."\n" ."\n" .'* **t**: The account has the permissions to create databases.'."\n" .'* **f**: The account does not have the permissions to create databases.'."\n" ."\n" .'> This parameter is returned only for instances that run PostgreSQL.'."\n", 'type' => 'string', 'example' => 't', ], 'CreateRole' => [ 'description' => 'Indicates whether the account has the permissions to create roles. Valid values:'."\n" ."\n" .'* **t**: The account has the permissions to create roles.'."\n" .'* **f**: The account does not have the permissions to create roles.'."\n" ."\n" .'> This parameter is returned only for instances that run PostgreSQL.'."\n", 'type' => 'string', 'example' => 't', ], 'DBInstanceId' => [ 'description' => 'The ID of the instance to which the account belongs.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5*****', ], 'DatabasePrivileges' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'DatabasePrivilege' => [ 'description' => 'The details about the permissions that are granted to the account.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'AccountPrivilege' => [ 'description' => 'The type of the permissions. Valid values:'."\n" ."\n" .'* **ReadWrite**: read and write permissions.'."\n" .'* **ReadOnly**: read-only permissions.'."\n" .'* **DDLOnly**: DDL-only permissions.'."\n" .'* **DMLOnly**: DML-only permissions.'."\n" .'* **Custom**: custom permissions. You can modify the permissions of the account by using SQL commands.'."\n", 'type' => 'string', 'example' => 'ReadWrite', ], 'AccountPrivilegeDetail' => [ 'description' => 'The permissions that are granted to the account. For more information, see [Account permissions](~~146395~~).'."\n", 'type' => 'string', 'example' => 'SELECT,INSERT', ], 'DBName' => [ 'description' => 'The name of the database.'."\n", 'type' => 'string', 'example' => 'test1', ], ], ], ], ], ], 'PasswordExpireTime' => [ 'description' => 'The expiration time of the password.'."\n" ."\n" .'> This parameter is returned only for instances that run SQL Server.'."\n", 'type' => 'string', 'example' => '2024-10-21', ], 'PrivExceeded' => [ 'title' => '', 'description' => 'Indicates whether the number of databases that are managed by the account exceeds the upper limit. Valid values:'."\n" ."\n" .'* **1**: The number of databases that are managed by the account exceeds the upper limit.'."\n" .'* **0**: The number of databases that are managed by the account does not exceed the upper limit.'."\n", 'type' => 'string', 'example' => '0', ], 'Replication' => [ 'description' => 'Indicates whether the account has the replication permissions. Valid values:'."\n" ."\n" .'* **t**: The account has the replication permissions.'."\n" .'* **f**: The account does not have the replication permissions.'."\n" ."\n" .'> This parameter is returned only for instances that run PostgreSQL.'."\n", 'type' => 'string', 'example' => 't', ], 'ValidUntil' => [ 'title' => '', 'description' => 'The expiration time of the password. Valid values:'."\n" ."\n" .'* **infinity**: The password never expires.'."\n" .'* **Empty**: The expiration time is not specified.'."\n" .'* **Actual expiration time**: in the format of *yyyy-MM-dd*T*HH:mm:ss*Z in UTC. Example: 2022-10-01T00:00:00Z.'."\n" ."\n" .'> This parameter is returned only for instances that run PostgreSQL.'."\n", 'type' => 'string', 'example' => '2022-10-01T00:00:00Z', ], ], ], ], ], ], 'PageNumber' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'A2E94301-D07F-4457-9B49-6AA2BB388C85', ], 'SystemAdminAccountFirstActivationTime' => [ 'description' => 'The first time when the system admin account was enabled. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is displayed in UTC.'."\n" ."\n" .'> This parameter is returned only for instances that run SQL Server.'."\n", 'type' => 'string', 'example' => '2020-02-06T11:00:00Z', ], 'SystemAdminAccountStatus' => [ 'description' => 'Indicates whether the system admin account was enabled. Valid values:'."\n" ."\n" .'* **true**: The system admin account was enabled.'."\n" .'* **false**: The system admin account was disabled.'."\n" ."\n" .'> The [system admin account](~~170736~~) is supported only for the instances that run SQL Server. If the instance runs SQL Server, a value is returned for this parameter. If the instance runs a different database engine, no value is returned for this parameter.'."\n", 'type' => 'string', 'example' => 'True', ], 'TotalRecordCount' => [ 'description' => 'The total number of entries that are returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'ResourceGroupId' => [ 'description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-acfmy****', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => '%s', 'errorMessage' => 'DB Operation Failed:%s.', ], [ 'errorCode' => 'IO.Exception', 'errorMessage' => 'IO exception, retry later.', ], [ 'errorCode' => 'Database.ConnectError', 'errorMessage' => 'Database connect error. please check instance status and database processlist', ], [ 'errorCode' => 'InvalidDBInstanceStatus.NotSupport', 'errorMessage' => 'The Specified instance status is not supported to query account list.', ], [ 'errorCode' => 'InvalidEngine.Malformed', 'errorMessage' => 'Specified engine is not valid.', ], [ 'errorCode' => 'Account.QueryError', 'errorMessage' => 'Query Account failed, please check your input value.', ], [ 'errorCode' => 'SqlExcutionFailed', 'errorMessage' => 'Database is already open and can only have one user at a time.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ConcurrentLimit', 'errorMessage' => 'The request processing has been concurrent limit.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'DbossGeneralError', 'errorMessage' => 'The instance is being created. Please wait.', ], [ 'errorCode' => 'InvalidCharacter.DbOrAccount', 'errorMessage' => 'The database name or account name contains invalid characters.', ], [ 'errorCode' => 'NoAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for account. We recommend that you add a payment method.', ], ], 403 => [ [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', ], [ 'errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 408 => [ [ 'errorCode' => 'NetworkOrSqlTimeoutError', 'errorMessage' => 'Failed to create login due to potential SQL Server overload or other issues that may cause the login creation fail. Please retry later.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Accounts\\": {\\n \\"DBInstanceAccount\\": [\\n {\\n \\"AccountDescription\\": \\"测试数据库账号\\",\\n \\"AccountName\\": \\"test1\\",\\n \\"AccountStatus\\": \\"Available\\",\\n \\"AccountType\\": \\"Normal\\",\\n \\"BypassRLS\\": \\"f\\",\\n \\"CheckPolicy\\": true,\\n \\"CreateDB\\": \\"t\\",\\n \\"CreateRole\\": \\"t\\",\\n \\"DBInstanceId\\": \\"rm-bp1v6z81ho9******\\",\\n \\"DatabasePrivileges\\": {\\n \\"DatabasePrivilege\\": [\\n {\\n \\"AccountPrivilege\\": \\"ReadWrite\\",\\n \\"AccountPrivilegeDetail\\": \\"SELECT,INSERT\\",\\n \\"DBName\\": \\"test1\\"\\n }\\n ]\\n },\\n \\"PasswordExpireTime\\": \\"2024-10-21\\",\\n \\"PrivExceeded\\": \\"0\\",\\n \\"Replication\\": \\"t\\",\\n \\"ValidUntil\\": \\"2022-10-01T00:00:00Z\\"\\n }\\n ]\\n },\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"17F2EA6C-3CA2-528D-A263-DC29707AD652\\",\\n \\"SystemAdminAccountFirstActivationTime\\": \\"2023-10-17T07:51:22Z\\",\\n \\"SystemAdminAccountStatus\\": \\"True\\",\\n \\"TotalRecordCount\\": 3,\\n \\"ResourceGroupId\\": \\"rg-acfmy****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n \\n \\n \\n \\n ReadWrite\\n SELECT,INSERT,UPDATE,DELETE,CREATE,DROP,REFERENCES,INDEX,ALTER,CREATE TEMPORARY TABLES,LOCK TABLES,CREATE VIEW,SHOW VIEW,CREATE ROUTINE,ALTER ROUTINE,EXECUTE,EVENT,TRIGGER\\n testdb\\n \\n \\n Available\\n \\n rm-uf6wjk5*****\\n testacc02\\n 0\\n Normal\\n \\n \\n A2E94301-D07F-4457-9B49-6AA2BB388C85\\n","errorExample":""}]', 'title' => 'DescribeAccounts', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* RDS MySQL'."\n" .'* RDS PostgreSQL'."\n" .'* RDS SQL Server'."\n" .'* RDS MariaDB'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeInstanceKeywords' => [ 'summary' => 'Queries the reserved keywords of an instance. The reserved keywords cannot be used for the usernames of accounts or the names of databases.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'Key', 'in' => 'query', 'schema' => [ 'description' => 'The type of reserved keyword to query. Valid values:'."\n" ."\n" .'* **account**'."\n" .'* **database**'."\n" ."\n" .'> This parameter is required.'."\n", 'type' => 'string', 'required' => false, 'example' => 'account', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Key' => [ 'description' => 'The type of reserved keyword returned.'."\n", 'type' => 'string', 'example' => 'account', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC', ], 'Words' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'word' => [ 'description' => 'The reserved keywords.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The reserved keyword.'."\n", 'type' => 'string', 'example' => 'login', ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Key\\": \\"account\\",\\n \\"RequestId\\": \\"1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC\\",\\n \\"Words\\": {\\n \\"word\\": [\\n \\"\\\\\\"dbo,login,admin,administrator\\\\\\"\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"DB6A907E-8686-4F66-8F2B-B31071CDE766\\n\\n dbo,login,admin,administrator\\n\\naccount","errorExample":""}]', 'title' => 'DescribeInstanceKeywords', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* RDS MySQL'."\n" .'* RDS PostgreSQL'."\n" .'* RDS SQL Server'."\n" .'* RDS MariaDB'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribePGHbaConfig' => [ 'summary' => 'Queries the configuration of the pg_hba.conf file of an ApsaraDB RDS for PostgreSQL instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'A reserved parameter. You do not need to specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => '1', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'pgm-bp1lymyn1v3i****', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy*****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'DBInstanceId' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-bp1*****', ], 'DefaultHbaItems' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'HbaItem' => [ 'description' => 'The default configuration items of the pg_hba.conf file.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Address' => [ 'description' => 'The IP addresses from which the specified users can access the specified databases. The value is fixed as 0.0.0.0/0.'."\n", 'type' => 'string', 'example' => '0.0.0.0/0', ], 'Database' => [ 'description' => 'The names of the databases that the specified users are allowed to access. The value is fixed as all or replication.'."\n", 'type' => 'string', 'example' => 'all', ], 'Mask' => [ 'description' => 'The mask of the instance. The value is fixed as null.'."\n", 'type' => 'string', 'example' => 'null', ], 'Method' => [ 'description' => 'The authentication method. The value is fixed as md5.'."\n", 'type' => 'string', 'example' => 'md5', ], 'Option' => [ 'description' => 'The value of this parameter is based on the value of the Method parameter. The value is fixed as null.'."\n", 'type' => 'string', 'example' => 'null', ], 'PriorityId' => [ 'description' => 'The priority of the configuration items in the pg_hba.conf file. This value is automatically generated.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'Type' => [ 'description' => 'The type of connection to the instance. The value is fixed as host.'."\n", 'type' => 'string', 'example' => 'host', ], 'User' => [ 'description' => 'The user that is allowed to access the instance. The value is fixed as all.'."\n", 'type' => 'string', 'example' => 'all', ], ], ], ], ], ], 'HbaModifyTime' => [ 'description' => 'The time when the previous modification was made to the pg_hba.conf file.'."\n", 'type' => 'string', 'example' => '2021-11-25T06:00:40Z', ], 'LastModifyStatus' => [ 'description' => 'The status of the previous modification to the pg_hba.conf file. Valid values:'."\n" ."\n" .'* **success**'."\n" .'* **setting**'."\n" .'* **failed**'."\n", 'type' => 'string', 'example' => 'success', ], 'ModifyStatusReason' => [ 'description' => 'The reason why the previous modification was made to the pg_hba.conf file.'."\n", 'type' => 'string', 'example' => 'The specified users (testuser) is not exist.', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'A147A124-A147-5CCF-9609-B73C028848DF', ], 'RunningHbaItems' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'HbaItem' => [ 'description' => 'The current configuration items of the pg_hba.conf file.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Address' => [ 'description' => 'The IP address of the client.'."\n", 'type' => 'string', 'example' => '0.0.0.0/0', ], 'Database' => [ 'description' => 'The name of the database.'."\n", 'type' => 'string', 'example' => 'all', ], 'Mask' => [ 'description' => 'The mask of the IP address.'."\n", 'type' => 'string', 'example' => 'null', ], 'Method' => [ 'description' => 'The authentication method.'."\n", 'type' => 'string', 'example' => 'md5', ], 'Option' => [ 'description' => 'The value of this parameter varies based on the value of the Method parameter. The value is fixed as null.'."\n", 'type' => 'string', 'example' => 'null', ], 'PriorityId' => [ 'description' => 'The priority.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'Type' => [ 'description' => 'The connection type. Valor:'."\n" ."\n" .'* **host**: The record matches TCP/IP connections, including SSL connections and non-SSL connections.'."\n" .'* **hostssl**: The record matches only TCP/IP connections that are established over SSL.'."\n" .'* **hostnossl**: The record matches only TCP/IP connections that are not established over SSL connections.'."\n", 'type' => 'string', 'example' => 'host', ], 'User' => [ 'description' => 'The username of the account.'."\n", 'type' => 'string', 'example' => 'all', ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', ], [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The specified DB instance name does not exist.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBInstanceId\\": \\"rm-bp1****\\",\\n \\"DefaultHbaItems\\": {\\n \\"HbaItem\\": [\\n {\\n \\"Address\\": \\"0.0.0.0/0\\",\\n \\"Database\\": \\"all\\",\\n \\"Mask\\": \\"null\\",\\n \\"Method\\": \\"md5\\",\\n \\"Option\\": \\"null\\",\\n \\"PriorityId\\": 0,\\n \\"Type\\": \\"host\\",\\n \\"User\\": \\"all\\"\\n }\\n ]\\n },\\n \\"HbaModifyTime\\": \\"2021-11-25T06:00:40Z\\",\\n \\"LastModifyStatus\\": \\"success\\",\\n \\"ModifyStatusReason\\": \\"The specified users (testuser) is not exist.\\",\\n \\"RequestId\\": \\"A147A124-A147-5CCF-9609-B73C028848DF\\",\\n \\"RunningHbaItems\\": {\\n \\"HbaItem\\": [\\n {\\n \\"Address\\": \\"0.0.0.0/0\\",\\n \\"Database\\": \\"all\\",\\n \\"Mask\\": \\"null\\",\\n \\"Method\\": \\"md5\\",\\n \\"Option\\": \\"null\\",\\n \\"PriorityId\\": 3,\\n \\"Type\\": \\"host\\",\\n \\"User\\": \\"all\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 2021-11-25T06:00:40Z\\n \\n A147A124-A147-5CCF-9609-B73C028848DF\\n success\\n \\n host\\n all\\n 0\\n

0.0.0.0/0

\\n md5\\n all\\n \\n \\n host\\n all\\n 3\\n

0.0.0.0/0

\\n md5\\n all\\n \\n","errorExample":""}]', 'title' => 'DescribePGHbaConfig', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'RDS PostgreSQL'."\n", ], 'DescribeModifyPGHbaConfigLog' => [ 'summary' => 'Queries the details about the modifications to the pg_hba.conf file of an ApsaraDB RDS for PostgreSQL instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'A reserved parameter. You do not need to specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => '1', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'pgm-bp1lymyn1v3i****', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in Coordinated Universal Time (UTC).'."\n", 'type' => 'string', 'required' => false, 'example' => '2021-11-25T05:00:40Z', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => 'The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => false, 'example' => '2021-11-25T06:00:40Z', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy*****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'DBInstanceId' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'pgm-bp1lymyn1v3i****', ], 'HbaLogItems' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'HbaLogItem' => [ 'description' => 'An array that consists of the modifications to the pg_hba.conf file.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'AfterHbaItems' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'HbaItem' => [ 'description' => 'The configurations of the pg_hba.conf file after modification.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Address' => [ 'description' => 'The IP address.'."\n", 'type' => 'string', 'example' => '0.0.0.0/0', ], 'Database' => [ 'description' => 'The name of the database.'."\n", 'type' => 'string', 'example' => 'all', ], 'Mask' => [ 'description' => 'The mask of the IP address.'."\n", 'type' => 'string', 'example' => 'null', ], 'Method' => [ 'description' => 'The authentication method.'."\n", 'type' => 'string', 'example' => 'ldap', ], 'Option' => [ 'description' => 'The value of this parameter was set based on the value of the Method parameter.'."\n", 'type' => 'string', 'example' => 'null', ], 'PriorityId' => [ 'description' => 'The priority.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'Type' => [ 'description' => 'The connection type.'."\n", 'type' => 'string', 'example' => 'host', ], 'User' => [ 'description' => 'The username of the account.'."\n", 'type' => 'string', 'example' => 'ldapuser', ], ], ], ], ], ], 'BeforeHbaItems' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'HbaItem' => [ 'description' => 'The configurations of the pg_hba.conf file before modification.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Address' => [ 'description' => 'The IP address.'."\n", 'type' => 'string', 'example' => '0.0.0.0/0', ], 'Database' => [ 'description' => 'The name of the database.'."\n", 'type' => 'string', 'example' => 'all', ], 'Mask' => [ 'description' => 'The mask of the IP address.'."\n", 'type' => 'string', 'example' => 'null', ], 'Method' => [ 'description' => 'The authentication method.'."\n", 'type' => 'string', 'example' => 'md5', ], 'Option' => [ 'description' => 'The value of this parameter varies based on the value of the Method parameter.'."\n", 'type' => 'string', 'example' => 'null', ], 'PriorityId' => [ 'description' => 'The priority.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'Type' => [ 'description' => 'The connection type.'."\n", 'type' => 'string', 'example' => 'host', ], 'User' => [ 'description' => 'The username of the account.'."\n", 'type' => 'string', 'example' => 'all', ], ], ], ], ], ], 'ModifyStatus' => [ 'description' => 'The status of the modification.'."\n" ."\n" .'* **success**: The modification is successful.'."\n" .'* **failed**: The modification failed.'."\n" .'* **setting**: The modification is being applied.'."\n", 'type' => 'string', 'example' => 'success', ], 'ModifyTime' => [ 'description' => 'The time when the pg_hba.conf file was modified. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2021-11-25T06:00:40Z', ], 'StatusReason' => [ 'description' => 'The reason why the modification failed.'."\n", 'type' => 'string', 'example' => 'null', ], ], ], ], ], ], 'LogItemCount' => [ 'description' => 'The number of modification records.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '6D797E6B-E157-510C-A27F-6F9E6DA40633', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidStartTime.Format', 'errorMessage' => 'Specified start time is not valid.', ], [ 'errorCode' => 'InvalidEndTime.Format', 'errorMessage' => 'Specified end time is not valid.', ], [ 'errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', ], [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The specified DB instance name does not exist.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBInstanceId\\": \\"pgm-bp1lymyn1v3i****\\",\\n \\"HbaLogItems\\": {\\n \\"HbaLogItem\\": [\\n {\\n \\"AfterHbaItems\\": {\\n \\"HbaItem\\": [\\n {\\n \\"Address\\": \\"0.0.0.0/0\\",\\n \\"Database\\": \\"all\\",\\n \\"Mask\\": \\"null\\",\\n \\"Method\\": \\"ldap\\",\\n \\"Option\\": \\"ldapserver=192.168.XX.XX ldapbasedn=\\\\\\"CN=Users,DC=pgsqldomain,DC=net\\\\\\" ldapbinddn=\\\\\\"CN=pgadminuser,CN=Users,DC=pgsqldomain,DC=net\\\\\\" ldapbindpasswd=\\\\\\"Test123!\\\\\\" ldapsearchattribute=\\\\\\"sAMAccountName\\\\\\"\\\\n\\",\\n \\"PriorityId\\": 0,\\n \\"Type\\": \\"host\\",\\n \\"User\\": \\"ldapuser\\"\\n }\\n ]\\n },\\n \\"BeforeHbaItems\\": {\\n \\"HbaItem\\": [\\n {\\n \\"Address\\": \\"0.0.0.0/0\\",\\n \\"Database\\": \\"all\\",\\n \\"Mask\\": \\"null\\",\\n \\"Method\\": \\"md5\\",\\n \\"Option\\": \\"null\\",\\n \\"PriorityId\\": 0,\\n \\"Type\\": \\"host\\",\\n \\"User\\": \\"all\\"\\n }\\n ]\\n },\\n \\"ModifyStatus\\": \\"success\\",\\n \\"ModifyTime\\": \\"2021-11-25T06:00:40Z\\",\\n \\"StatusReason\\": \\"null\\"\\n }\\n ]\\n },\\n \\"LogItemCount\\": 1,\\n \\"RequestId\\": \\"6D797E6B-E157-510C-A27F-6F9E6DA40633\\"\\n}","errorExample":""},{"type":"xml","example":"\\n pgm-bp1lymyn1v3i****\\n 6D797E6B-E157-510C-A27F-6F9E6DA40633\\n 1\\n \\n success\\n \\n 2021-11-25T06:00:40Z\\n \\n host\\n all\\n 0\\n

0.0.0.0/0

\\n md5\\n all\\n \\n \\n host\\n all\\n 0\\n

0.0.0.0/0

\\n ldapserver=ECS服务器的私网IP ldapbasedn=\\"CN=Users,DC=pgsqldomain,DC=net\\" ldapbinddn=\\"CN=AD域中创建的管理员用户名,CN=Users,DC=pgsqldomain,DC=net\\" ldapbindpasswd=\\"AD域中创建的管理员用户密码\\" ldapsearchattribute=\\"sAMAccountName\\"\\n ldap\\n ldapuser\\n \\n \\n","errorExample":""}]', 'title' => 'DescribeModifyPGHbaConfigLog', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'RDS PostgreSQL'."\n", ], 'ResetAccountPassword' => [ 'summary' => 'Resets the password of a database account.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-uf6wjk5xxxxxxx', ], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => [ 'description' => 'The username of the account.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test1', ], ], [ 'name' => 'AccountPassword', 'in' => 'query', 'schema' => [ 'description' => 'The new password.'."\n" ."\n" .'> * The value must be 8 to 32 characters in length.'."\n" .'> * The value must contain at least three types of the following characters: uppercase letters, lowercase letters, digits, and special characters.'."\n" .'> * The following special characters are supported: ! @ # $ & % ^ \\* ( ) \\_ + - =', 'type' => 'string', 'required' => true, 'example' => 'Test123456', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'D4D4BE8A-DD46-440A-BFCD-EE31DA81C9DD', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => '%s', 'errorMessage' => 'DB Operation Failed:%s.', ], [ 'errorCode' => 'Database.ConnectError', 'errorMessage' => 'Database connect error. please check instance status and database processlist', ], [ 'errorCode' => 'GdnRole.NotSupport', 'errorMessage' => 'Specified gdn role is not support.', ], [ 'errorCode' => 'InvalidAccountPassword.Format', 'errorMessage' => 'Specified account password is not valid.', ], [ 'errorCode' => 'IncorrectAccountStatus', 'errorMessage' => 'Current account status does not support this operation.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'DbossGeneralError', 'errorMessage' => 'The instance is being created. Please wait.', ], [ 'errorCode' => 'Account.UpdateError', 'errorMessage' => 'Failed to update the account. Check the request parameters or instance parameter policies. Make sure that the host value of the account is set to % (allows logins from all hosts).', ], ], [ [ 'errorCode' => 'Account.SupabaseAdminRestricted', 'errorMessage' => 'This account is managed by Supabase and is restricted from direct modification. Please use the Supabase Console or API.', ], ], 403 => [ [ 'errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', ], [ 'errorCode' => 'IncorrectAccountType', 'errorMessage' => 'Current account type does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstanceCharacterType', 'errorMessage' => 'Current DB Instance character_type does not support this operation.', ], [ 'errorCode' => 'IncorrectAccountPrivilegeType', 'errorMessage' => 'the current account privilege type does not support this operation.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', ], [ 'errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', ], [ 'errorCode' => 'InvalidAccountName.NotFound', 'errorMessage' => 'Specified account name does not exist.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D4D4BE8A-DD46-440A-BFCD-EE31DA81C9DD\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"7463B73D-35CC-4D19-A010-6B8D65D242EF\\",\\n \\"HostId\\": \\"rds.aliyuncs.com\\",\\n \\"Code\\": \\"UnsupportedOperation\\",\\n \\"Message\\": \\"The specified action is not supported.\\"\\n}"},{"type":"xml","example":"\\n\\n\\tD4D4BE8A-DD46-440A-BFCD-EE31DA81C9DD\\n\\n\\t\\n","errorExample":""}]', 'title' => 'ResetAccountPassword', 'description' => '### Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" .'* MariaDB'."\n" ."\n" .'### References'."\n" ."\n" .'> Before you call this operation, read the following documentation and make sure that you fully understand the prerequisites and impacts of this operation.'."\n" ."\n" .'* [Reset the password of an ApsaraDB RDS for MySQL instance](~~96100~~)'."\n" .'* [Reset the password of an ApsaraDB RDS for PostgreSQL instance](~~96814~~)'."\n" .'* [Reset the password of an ApsaraDB RDS for SQL Server instance](~~95691~~)'."\n" .'* [Reset the password of an ApsaraDB RDS for MariaDB instance](~~97133~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'LockAccount' => [ 'summary' => 'Locks an account of an ApsaraDB RDS for PostgreSQL instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pgm-bpxxxxx', ], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => [ 'description' => 'The account that you want to lock. You can lock only a single account at a time.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'testaccount', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1B291C4B-DDCD-4D0A-8F6D-7F3241DE9228', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], [ [ 'errorCode' => 'Account.SupabaseAdminRestricted', 'errorMessage' => 'This account is managed by Supabase and is restricted from direct modification. Please use the Supabase Console or API.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1B291C4B-DDCD-4D0A-8F6D-7F3241DE9228\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 1B291C4B-DDCD-4D0A-8F6D-7F3241DE9228\\r\\n","errorExample":""}]', 'title' => 'LockAccount', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'PostgreSQL'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.'."\n" ."\n" .'[Lock an account of an ApsaraDB RDS for PostgreSQL instance](~~147649~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'UnlockAccount' => [ 'summary' => 'Unlocks a database account of an ApsaraDB RDS for PostgreSQL instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pgm-bpxxxxx', ], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => [ 'description' => 'The account that you want to unlock. You can unlock a single account at a time.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'testaccount', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'AA65190D-852A-4C9B-88DA-E92698CAA350', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"AA65190D-852A-4C9B-88DA-E92698CAA350\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\nAA65190D-852A-4C9B-88DA-E92698CAA350\\r\\n","errorExample":""}]', 'title' => 'UnlockAccount', 'description' => '### Supported database engine'."\n" ."\n" .'PostgreSQL'."\n" ."\n" .'### References'."\n" ."\n" .'> Before you call this operation, read the following documentation and make sure that you fully understand the prerequisites and impacts of this operation.'."\n" ."\n" .'[Lock an account of an ApsaraDB RDS for PostgreSQL instance](~~147649~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'GrantAccountPrivilege' => [ 'summary' => 'Grants an account the permissions on a database of an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-uf6wjk5xxxxxxxxxx', ], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => [ 'description' => 'The username of the account.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test1', ], ], [ 'name' => 'DBName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the database on which you want to grant permissions. Separate multiple database names with commas (,).'."\n", 'type' => 'string', 'required' => true, 'example' => 'testDB1', ], ], [ 'name' => 'AccountPrivilege', 'in' => 'query', 'schema' => [ 'description' => 'The permissions that you want to grant to the account. The number of permissions must be the same as the number of databases that you specify for the DBName parameter. You can specify this parameter based on your business requirements. Valid values:'."\n" ."\n" .'* **ReadWrite**: read and write permissions'."\n" .'* **ReadOnly**: read-only permissions'."\n" .'* **DDLOnly**: DDL-only permissions'."\n" .'* **DMLOnly**: DML-only permissions'."\n" .'* **DBOwner**: database owner permissions'."\n" ."\n" .'> '."\n" ."\n" .'* If the instance runs MySQL or MariaDB, you can set this parameter to **ReadWrite**, **ReadOnly**, **DDLOnly**, or **DMLOnly**.'."\n" ."\n" .'* If the instance runs SQL Server, you can set this parameter to **ReadWrite**, **ReadOnly**, or **DBOwner**.'."\n" .'* If the instance runs PostgreSQL and uses cloud disks, you can set this parameter to **DBOwner**.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ReadWrite', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '81BC9559-7B22-4B7F-B705-5F56DEECDEA7', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => '%s', 'errorMessage' => 'DB Operation Failed:%s.', ], [ 'errorCode' => 'Account.UpdateError', 'errorMessage' => 'Update Account failed, please check your input value', ], [ 'errorCode' => 'Database.ConnectError', 'errorMessage' => 'Database connect error. please check instance status and database processlist', ], [ 'errorCode' => 'DbRestoring', 'errorMessage' => 'Database is in restoring state.', ], [ 'errorCode' => 'InvalidAccountPrivilege.Malformed', 'errorMessage' => 'Specified account privilege is not valid.', ], [ 'errorCode' => 'IncorrectAccountStatus', 'errorMessage' => 'Current account status does not support this operation.', ], [ 'errorCode' => 'IncorrectAccount', 'errorMessage' => 'Current DB instance account does not support this operation.', ], [ 'errorCode' => 'InvalidDBNameOrAccountPrivilege', 'errorMessage' => 'Account permissions and database names must correspond.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'DbossGeneralError', 'errorMessage' => 'The instance is being created. Please wait.', ], [ 'errorCode' => 'InvalidCharacter.DbOrAccount', 'errorMessage' => 'The database name or account name contains invalid characters.', ], ], 403 => [ [ 'errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', ], [ 'errorCode' => 'IncorrectAccountType', 'errorMessage' => 'Current account type does not support this operation.', ], [ 'errorCode' => 'IncorrectAccountPrivilegeType', 'errorMessage' => 'the current account privilege type does not support this operation.', ], [ 'errorCode' => 'OperationDenied.AccountMode', 'errorMessage' => 'The operation is not permitted due to account mode of instance.', ], [ 'errorCode' => 'IncorrectDBInstanceCharacterType', 'errorMessage' => 'Current DB Instance character_type does not support this operation.', ], [ 'errorCode' => 'SqlExcutionFailed', 'errorMessage' => 'Failed to connect to host: connection timed out.', ], [ 'errorCode' => 'SQLPermissionOperationFailed', 'errorMessage' => 'The T-SQL statement for account operation on the current RDS instance failed. For specific reasons, please refer the info returned by SQL Server in the RDSAPI logs.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], [ 'errorCode' => 'UnsupportedByBlueGreenDeployment', 'errorMessage' => 'Operation prohibited due to blue green deployment.', ], ], [ [ 'errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', ], [ 'errorCode' => 'InvalidAccountName.NotFound', 'errorMessage' => 'Specified account name does not exist.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"81BC9559-7B22-4B7F-B705-5F56DEECDEA7\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"7463B73D-35CC-4D19-A010-6B8D65D242EF\\",\\n \\"HostId\\": \\"rds.aliyuncs.com\\",\\n \\"Code\\": \\"UnsupportedOperation\\",\\n \\"Message\\": \\"The specified action is not supported.\\"\\n}"},{"type":"xml","example":"\\n\\n\\t81BC9559-7B22-4B7F-B705-5F56DEECDEA7\\n\\n\\t\\n","errorExample":""}]', 'title' => 'GrantAccountPrivilege', 'description' => 'Each account can be granted permissions on one or more databases. Before you call this operation, make sure that the instance is in the Running state.'."\n" ."\n" .'> This operation is not supported for instances that run SQL Server 2017 on RDS Cluster Edition or run PostgreSQL with local disks.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'GrantOperatorPermission' => [ 'summary' => 'Grant permissions to a service account.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'create', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-uf6wjk5xxxxxxx', ], ], [ 'name' => 'ExpiredTime', 'in' => 'query', 'schema' => [ 'description' => 'The expiration time of the permissions. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => true, 'example' => '2019-03-27T16:00:00Z', ], ], [ 'name' => 'Privileges', 'in' => 'query', 'schema' => [ 'description' => 'The permissions that you want to grant to the service account. Valid values:'."\n" ."\n" .'* **Control**: the configuration permissions, which allow you to view and modify configurations of the instance.'."\n" .'* **Data**: the data permissions, which allow you to view schemas, indexes, and SQL statements of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'Control', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '842B73C8-5776-4BD9-9872-69C8C46DD7D3', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"842B73C8-5776-4BD9-9872-69C8C46DD7D3\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 842B73C8-5776-4BD9-9872-69C8C46DD7D3\\r\\n","errorExample":""}]', 'title' => 'GrantOperatorPermission', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* SQL Server'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> Before you call this operation, read the following documentation and make sure that you fully understand the prerequisites and impacts of this operation.'."\n" ."\n" .'* [Grant permissions to the service account of an ApsaraDB RDS for MySQL instance](~~96102~~)'."\n" .'* [Grant permissions to the service account of an ApsaraDB RDS for SQL Server instance](~~95693~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'RevokeOperatorPermission' => [ 'summary' => 'Revokes permissions from the service account of an ApsaraDB RDS instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'delete', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-uf6wjk5xxxxxxx', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '842B73C8-5776-4BD9-9872-69C8C46DD7D3', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"842B73C8-5776-4BD9-9872-69C8C46DD7D3\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 842B73C8-5776-4BD9-9872-69C8C46DD7D3\\r\\n","errorExample":""}]', 'title' => 'RevokeOperatorPermission', 'description' => '### Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" ."\n" .'### References'."\n" ."\n" .'> Before you call this operation, read the following documentation and make sure that you fully understand the prerequisites and impacts of this operation.'."\n" ."\n" .'* [Grant permissions to the service account of an ApsaraDB RDS for MySQL instance](~~96102~~)'."\n" .'* [Grant permissions to the service account of an ApsaraDB RDS for PostgreSQL instance](~~146887~~)'."\n" .'* [Grant permissions to the service account of an ApsaraDB RDS for SQL Server instance](~~95693~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'RevokeAccountPrivilege' => [ 'summary' => 'Removes the permissions on a database of an ApsaraDB RDS instance from an account.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-uf6wjk5xxxxxxx', ], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the account.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test1', ], ], [ 'name' => 'DBName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the database. You can revoke all permissions of the account on this database. Separate multiple databases with commas (,).'."\n", 'type' => 'string', 'required' => true, 'example' => 'testDB', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'E22099CA-A61E-4992-A0B7-CE82DC175626', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => '%s', 'errorMessage' => 'DB Operation Failed:%s.', ], [ 'errorCode' => 'Account.UpdateError', 'errorMessage' => 'Update Account failed, please check your input value', ], [ 'errorCode' => 'Database.ConnectError', 'errorMessage' => 'Database connect error. please check instance status and database processlist', ], [ 'errorCode' => 'DbRestoring', 'errorMessage' => 'Database is in restoring state.', ], [ 'errorCode' => 'SqlExcutionFailed', 'errorMessage' => 'Database is in transition. Try the statement later.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'InvalidCharacter.DbOrAccount', 'errorMessage' => 'The database name or account name contains invalid characters.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E22099CA-A61E-4992-A0B7-CE82DC175626\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"7463B73D-35CC-4D19-A010-6B8D65D242EF\\",\\n \\"HostId\\": \\"rds.aliyuncs.com\\",\\n \\"Code\\": \\"UnsupportedOperation\\",\\n \\"Message\\": \\"The specified action is not supported.\\"\\n}"},{"type":"xml","example":"\\n\\n\\tE22099CA-A61E-4992-A0B7-CE82DC175626\\n\\n\\t","errorExample":""}]', 'title' => 'RevokeAccountPrivilege', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* SQL Server'."\n" .'* MariaDB'."\n" ."\n" .'### [](#)Prerequisites'."\n" ."\n" .'* The instance is in the Running state.'."\n" .'* The database is in the Running state.'."\n" ."\n" .'### [](#)Precautions'."\n" ."\n" .'* The permissions that can be revoked include SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, REFERENCES, INDEX, ALTER, CREATE TEMPORARY TABLES, LOCK TABLES, EXECUTE, CREATE VIEW, SHOW VIEW, CREATE ROUTINE, ALTER ROUTINE, EVENT, and TRIGGER.'."\n" .'* This operation is not supported for instances that run SQL Server 2017 on RDS Cluster Edition and run PostgreSQL.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ResetAccount' => [ 'summary' => 'Resets the permissions of the privileged account.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-uf6wjk5xxxxxxx', ], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the privileged account.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test1', ], ], [ 'name' => 'AccountPassword', 'in' => 'query', 'schema' => [ 'description' => 'The new password of the privileged account.'."\n" ."\n" .'> '."\n" ."\n" .'* The password must be 8 to 32 characters in length.'."\n" ."\n" .'* It must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters.'."\n" ."\n" .'* It can contain the following special characters: `! @ # $ & ; % ^ * () _ + - =`.'."\n", 'type' => 'string', 'required' => true, 'example' => 'Test123456', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '81BC9559-7B22-4B7F-B705-5F56DEECDEA7', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Account.UpdateError', 'errorMessage' => 'Update Account failed, please check your input value', ], [ 'errorCode' => 'Database.ConnectError', 'errorMessage' => 'Database connect error. please check instance status and database processlist', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"81BC9559-7B22-4B7F-B705-5F56DEECDEA7\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"7463B73D-35CC-4D19-A010-6B8D65D242EF\\",\\n \\"HostId\\": \\"rds.aliyuncs.com\\",\\n \\"Code\\": \\"UnsupportedOperation\\",\\n \\"Message\\": \\"The specified action is not supported.\\"\\n}"},{"type":"xml","example":"\\n\\n\\t81BC9559-7B22-4B7F-B705-5F56DEECDEA7\\n\\n\\t\\n","errorExample":""}]', 'title' => 'ResetAccount', 'description' => '### Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* SQL Server'."\n" .'* MariaDB'."\n" ."\n" .'### References'."\n" ."\n" .'> Before you call this operation, read the following documentation and make sure that you fully understand the prerequisites and impacts of this operation.'."\n" ."\n" .'[Reset of the permissions of privileged accounts](~~140724~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'CheckAccountNameAvailable' => [ 'summary' => 'Checks whether the username of the account that you want to create on an instance is available.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxxxxx', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => ' rm-uf6wjk5xxxxx', ], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => [ 'description' => 'The username of the account.'."\n" ."\n" .'* The value must be unique.'."\n" ."\n" .'* The value must start with a lowercase letter, and end with a lowercase letter or a digit.'."\n" ."\n" .'* The value can contain lowercase letters, digits, and underscores (\\_).'."\n" ."\n" .'* The length of the value must meet the following requirements:'."\n" ."\n" .' * If the instance runs MySQL 5.7 or MySQL 8.0, the value must be 2 to 32 characters in length.'."\n" .' * If the instance runs MySQL 5.6, the value must be 2 to 16 characters in length.'."\n" .' * If the instance runs SQL Server, the value must be 2 to 64 characters in length.'."\n" .' * If the instance runs PostgreSQL with cloud disks, the value must be 2 to 63 characters in length.'."\n" .' * If the instance runs PostgreSQL with local disks, the value must be 2 to 16 characters in length.'."\n" .' * If the instance runs MariaDB, the value must be 2 to 16 characters in length.'."\n" ."\n" .'* For more information about invalid characters, see [Forbidden keywords table](~~26317~~).', 'type' => 'string', 'required' => true, 'example' => 'DatabaseTest', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '5E4AA101-1EE5-41C0-AE6D-0F066331AC1C', ], 'ResourceGroupId' => [ 'description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'example' => 'rg-acfmy****', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Database.ConnectError', 'errorMessage' => 'Database connect error. please check instance status and database processlist', ], [ 'errorCode' => 'InvalidConnectionInfo', 'errorMessage' => 'Specified ConnectionInfo is not valid.', ], [ 'errorCode' => 'Account.QueryError', 'errorMessage' => 'Query Account failed, please check your input value.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5E4AA101-1EE5-41C0-AE6D-0F066331AC1C\\",\\n \\"ResourceGroupId\\": \\"rg-acfmy****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 5E4AA101-1EE5-41C0-AE6D-0F066331AC1C\\r\\n","errorExample":""}]', 'title' => 'CheckAccountNameAvailable', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" .'* MariaDB'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'CreateDatabase' => [ 'summary' => 'Creates a database in an ApsaraDB RDS instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the [DescribeDBInstances](~~610396~~) operation to query the ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5xxxxxxxxxx', ], ], [ 'name' => 'DBName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the database.'."\n" ."\n" .'> * The name must be 2 to 64 characters in length.'."\n" .'> * The name must start with a lowercase letter and end with a lowercase letter or digit.'."\n" .'> * The name can contain lowercase letters, digits, underscores (\\_), and hyphens (-).'."\n" .'> * The name must be unique within the instance.'."\n" .'> * For more information about invalid characters, see [Forbidden keywords table](~~26317~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rds_mysql', ], ], [ 'name' => 'CharacterSetName', 'in' => 'query', 'schema' => [ 'description' => 'The character set.'."\n" ."\n" .'* Valid values for MySQL or MariaDB databases: **utf8, gbk, latin1, and utf8mb4**'."\n" ."\n" .'* Valid values for SQL Server databases: **Chinese_PRC_CI_AS, Chinese_PRC_CS_AS, SQL_Latin1\\_General_CP1\\_CI_AS, SQL_Latin1\\_General_CP1\\_CS_AS, and Chinese_PRC_BIN**'."\n" ."\n" .'* Valid values for PostgreSQL databases: a value in the `Character set,,` format. Example: `UTF8,C,en_US.utf8`.'."\n" ."\n" .' * Valid values for the character set: **KOI8U, UTF8, WIN866, WIN874, WIN1250, WIN1251, WIN1252, WIN1253, WIN1254, WIN1255, WIN1256, WIN1257, WIN1258, EUC_CN, EUC_KR, EUC_TW, EUC_JP, EUC_JIS\\_2004, KOI8R, MULE_INTERNAL, LATIN1, LATIN2, LATIN3, LATIN4, LATIN5, LATIN6, LATIN7, LATIN8, LATIN9, LATIN10, ISO\\_8859\\_5, ISO\\_8859\\_6, ISO\\_8859\\_7, ISO\\_8859\\_8, and SQL_ASCII**'."\n" .' * Valid values for the **Collate** field: You can execute the `SELECT DISTINCT collname FROM pg_collation;` statement to obtain the field value. The default value is **C**.'."\n" .' * Valid values for the **Ctype** field: You can execute the `SELECT DISTINCT collctype FROM pg_collation;` statement to obtain the field value. The default value is **en_US.utf8**.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'gbk', ], ], [ 'name' => 'DBDescription', 'in' => 'query', 'schema' => [ 'description' => 'The description of the database. The description must be 2 to 256 characters in length and can contain letters, digits, underscores (\\_), and hyphens (-). The description must start with a letter.'."\n" ."\n" .'> The value cannot start with `http://` or `https://`.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Database for testing'."\n", ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '5A77D650-27A1-4E08-AD9E-59008EDB6927', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => '%s', 'errorMessage' => 'DB Operation Failed:%s.', ], [ 'errorCode' => 'EngineMigration.ActionDisabled', 'errorMessage' => 'Specified action is disabled while custins is in engine migration.', ], [ 'errorCode' => 'Database.ConnectError', 'errorMessage' => 'Database connect error. please check instance status and database processlist', ], [ 'errorCode' => 'InvalidDescription.Format', 'errorMessage' => 'Specified description is not valid.', ], [ 'errorCode' => 'InvalidDBName.Forbid', 'errorMessage' => 'Specified DB name is a keyword in RDS.', ], [ 'errorCode' => 'InvalidAccountName.Forbid', 'errorMessage' => 'Specified account name is a keyword in RDS.', ], [ 'errorCode' => 'InvalidAccountPrivilege.Malformed', 'errorMessage' => 'Specified account privilege is not valid.', ], [ 'errorCode' => 'IncorrectDBInstanceServiceType', 'errorMessage' => 'Current DB instance top type does not support this operation.', ], [ 'errorCode' => 'Database.AddError', 'errorMessage' => 'Create Db failed, please check input value and instance status.', ], [ 'errorCode' => 'Database.QueryError', 'errorMessage' => 'invalid value, may include special character.', ], [ 'errorCode' => 'SqlExcutionFailed', 'errorMessage' => 'Due to the limit number you can\'t create a database.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'InvalidDBInstanceIdOrDBInstanceName', 'errorMessage' => 'The specified params DBInstanceId or DBInstanceName should not be empty.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'InvalidCharacter.DbOrAccount', 'errorMessage' => 'The database name or account name contains invalid characters.', ], [ 'errorCode' => 'InvalidDBName.Duplicate', 'errorMessage' => 'Specified DB name already exists in the This instance.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], [ 'errorCode' => 'UnsupportedByBlueGreenDeployment', 'errorMessage' => 'Operation prohibited due to blue green deployment.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A77D650-27A1-4E08-AD9E-59008EDB6927\\"\\n}","type":"json"}]', 'title' => 'CreateDatabase', 'description' => '### Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" .'* MariaDB'."\n" ."\n" .'### References'."\n" ."\n" .'> Before you call this operation, read the following documentation and make sure that you fully understand the prerequisites and impacts of this operation.'."\n" ."\n" .'* [Create a database in an ApsaraDB RDS for MySQL instance](~~96105~~)'."\n" .'* [Create a database in an ApsaraDB RDS for PostgreSQL instance](~~96758~~)'."\n" .'* [Create a database in an ApsaraDB RDS for SQL Server instance](~~95698~~)'."\n" .'* [Create a database in an ApsaraDB RDS for MariaDB instance](~~97136~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DeleteDatabase' => [ 'summary' => 'Deletes a database from an RDS instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5*****', ], ], [ 'name' => 'DBName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'testdb01', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '07F6177E-6DE4-408A-BB4F-0723301340F3', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Database.ConnectError', 'errorMessage' => 'Database connect error. please check instance status and database processlist', ], [ 'errorCode' => 'InvalidDBName.Forbid', 'errorMessage' => 'Specified DB name is a keyword in RDS.', ], [ 'errorCode' => 'Database.DelError', 'errorMessage' => 'Failed to delete the database. Check the specified parameters and the instance state.', ], [ 'errorCode' => 'ColdDBHasSameNameWithOnlineDB', 'errorMessage' => 'The instance has cold db and online db with the same name.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'InvalidCharacter.DbOrAccount', 'errorMessage' => 'The database name or account name contains invalid characters.', ], ], 403 => [ [ 'errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', ], [ 'errorCode' => 'OperationDenied.AccountMode', 'errorMessage' => 'The operation is not permitted due to account mode of instance.', ], [ 'errorCode' => 'IncorrectDBInstanceCharacterType', 'errorMessage' => 'Current DB Instance character_type does not support this operation.', ], [ 'errorCode' => 'IncorrectDBType', 'errorMessage' => 'The current DB type does not support this operation.', ], [ 'errorCode' => 'IncorrectDBState', 'errorMessage' => 'The current DB state does not support this operation.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], [ 'errorCode' => 'UnsupportedByBlueGreenDeployment', 'errorMessage' => 'Operation prohibited due to blue green deployment.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', ], [ 'errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', ], [ 'errorCode' => 'InvalidDBName.NotFound', 'errorMessage' => 'Specified one or more DB name does not exist or DB status does not support.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"07F6177E-6DE4-408A-BB4F-0723301340F3\\"\\n}","type":"json"}]', 'title' => 'DeleteDatabase', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* RDS MySQL'."\n" .'* RDS PostgreSQL'."\n" .'* RDS SQL Server'."\n" .'* RDS MariaDB'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> : Before you call this operation, read the following documentation and make sure that you fully understand the prerequisites and impacts of this operation.'."\n" ."\n" .'* [Delete a database from an ApsaraDB RDS for MySQL instance](~~96106~~)'."\n" .'* [Delete a database from an ApsaraDB RDS for PostgreSQL instance](~~96759~~)'."\n" .'* [Delete a database from an ApsaraDB RDS for SQL Server instance](~~95699~~)'."\n" .'* [Delete a database from an ApsaraDB RDS for MariaDB instance](~~97137~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'CopyDatabase' => [ 'summary' => 'Replicates the databases of an instance that runs SQL Server 2008 R2 to another instance. This operation is phased out.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', ], 'parameters' => [ [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => [ 'description' => 'The instance name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rm-uf6wjk5******', ], ], [ 'name' => 'SrcDBName', 'in' => 'query', 'schema' => [ 'description' => 'The source database name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'db1***', ], ], [ 'name' => 'DstDBName', 'in' => 'query', 'schema' => [ 'description' => 'The destination database name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'db2***', ], ], [ 'name' => 'ReserveAccount', 'in' => 'query', 'schema' => [ 'description' => 'The reserved account.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy*****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'DBName' => [ 'description' => 'The name of the database.'."\n", 'type' => 'string', 'example' => 'test02', ], 'DBStatus' => [ 'description' => 'The status of the database. Valid values:'."\n" ."\n" .'* **Creating**'."\n" .'* **Running**'."\n" .'* **Deleting**'."\n", 'type' => 'string', 'example' => ' Creating', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', ], 'TaskId' => [ 'description' => 'The ID of the task.'."\n", 'type' => 'string', 'example' => '2562****', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidDBName.Format', 'errorMessage' => 'Specified DB name is not valid.', ], [ 'errorCode' => 'InvalidDBName.Forbid', 'errorMessage' => 'Specified DB name is a keyword in RDS.', ], [ 'errorCode' => 'InvalidDBName.Duplicate', 'errorMessage' => 'Specified DB name already exists in the This instance.', ], [ 'errorCode' => 'InvalidAccountName.Format', 'errorMessage' => 'Specified account name is not valid.', ], [ 'errorCode' => 'InvalidAccountName.Forbid', 'errorMessage' => 'Specified account name is a keyword in RDS.', ], [ 'errorCode' => 'InvalidCharacterSetName.Format', 'errorMessage' => 'Specified character set name is not valid.', ], [ 'errorCode' => 'InvalidAccountPrivilege.Malformed', 'errorMessage' => 'Specified account privilege is not valid.', ], [ 'errorCode' => 'InvalidAccountPassword.Format', 'errorMessage' => 'Specified account password is not valid.', ], [ 'errorCode' => 'InvalidDBDescription.Format', 'errorMessage' => 'Specified DB description is not valid.', ], [ 'errorCode' => 'InvalidReserveAccount.Format', 'errorMessage' => 'Specified ReserveAccount is not valid.', ], [ 'errorCode' => 'IncorrectEngineVersion', 'errorMessage' => 'Current engine version does not support operations.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'DBLimitExceeded', 'errorMessage' => 'DBQuotaExceeded: Exceeding the allowed amount of DB.', ], [ 'errorCode' => 'AccountLimitExceeded', 'errorMessage' => 'AccountQuotaExceeded: Exceeding the allowed amount of account', ], [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', ], [ 'errorCode' => 'OperationDenied.AccountMode', 'errorMessage' => 'The operation is not permitted due to account mode of instance.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBName.NotFound', 'errorMessage' => 'Specified one or more DB name does not exist or DB status does not support.', ], [ 'errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', ], [ 'errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'Specified instance does not exist or not support.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBName\\": \\"test02\\",\\n \\"DBStatus\\": \\" Creating\\",\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"TaskId\\": \\"2562****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n\\n\\t5A77D650-27A1-4E08-AD9E-59008EDB6927\\n\\t\\n","errorExample":""}]', 'title' => 'CopyDatabase', 'description' => 'This operation is phased out.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ModifyDBDescription' => [ 'summary' => 'Modifies the description of an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-uf6wjk5xxxxxxx', ], ], [ 'name' => 'DBName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testDB01', ], ], [ 'name' => 'DBDescription', 'in' => 'query', 'schema' => [ 'description' => 'The description of the database.'."\n", 'type' => 'string', 'required' => true, 'example' => 'Test database A'."\n", ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '17F57FEE-EA4F-4337-8D2E-9C23CAA63D74', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => '%s', 'errorMessage' => 'DB Operation Failed:%s.', ], [ 'errorCode' => 'Database.ConnectError', 'errorMessage' => 'Database connect error. please check instance status and database processlist', ], [ 'errorCode' => 'IncorrectDBInstanceLockMode.ValueNotSupported', 'errorMessage' => 'The Current DB instance lock mode does not support this operation.', ], [ 'errorCode' => 'InvalidDBDescription.Format', 'errorMessage' => 'Specified DB description is not valid.', ], [ 'errorCode' => 'InvalidDBName.NotFound', 'errorMessage' => 'Specified DB name does not exist.', ], [ 'errorCode' => 'Database.UpdateError', 'errorMessage' => 'Update Db failed, please check input value and instance status.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance engine and type does not support operations.', ], [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"17F57FEE-EA4F-4337-8D2E-9C23CAA63D74\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"7463B73D-35CC-4D19-A010-6B8D65D242EF\\",\\n \\"HostId\\": \\"rds.aliyuncs.com\\",\\n \\"Code\\": \\"UnsupportedOperation\\",\\n \\"Message\\": \\"The specified action is not supported.\\"\\n}"},{"type":"xml","example":"\\n\\n\\t 17F57FEE-EA4F-4337-8D2E-9C23CAA63D74\\n\\n\\t\\n","errorExample":""}]', 'title' => 'ModifyDBDescription', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* RDS MySQL'."\n" .'* RDS PostgreSQL'."\n" .'* RDS SQL Server'."\n" .'* RDS MariaDB'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ModifyDatabaseConfig' => [ 'summary' => 'Modifies the property settings of an ApsaraDB RDS for SQL Server instance.', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'paid', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-t4nnu1my39qr8****', ], ], [ 'name' => 'DBName', 'in' => 'query', 'schema' => [ 'description' => 'The database name.'."\n" ."\n" .'> You can specify only one database name.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testDB', ], ], [ 'name' => 'DatabasePropertyName', 'in' => 'query', 'schema' => [ 'description' => 'The database property that you want to modify.'."\n" ."\n" .'* **If you want to modify a property of the database**, set this parameter to the name of the database property.'."\n" .'* **If you want to archive data from the database to an OSS bucket**, specify the database status. If you set this parameter to `covert_online_db_to_cold_storage`, the system converts an online database to a cold storage database. If you set this parameter to `convert_cold_storage_db_to_online`, the system converts a cold storage database to an online database.'."\n", 'type' => 'string', 'required' => true, 'example' => 'compatibility_level', ], ], [ 'name' => 'DatabasePropertyValue', 'in' => 'query', 'schema' => [ 'description' => 'The value of the database property that you want to modify.'."\n" ."\n" .'* **If you want to modify a property of the database**, set this parameter to the property value.'."\n" .'* **If you want to archive data from the database to an OSS bucket**, set this parameter to **1**. The system converts a database to a cold storage database or an online database.'."\n", 'type' => 'string', 'required' => true, 'example' => '150', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Code' => [ 'description' => 'The code.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'success', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '8B993DA9-5272-5414-94E3-4CA8BA0146C2', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => '%s.', ], [ 'errorCode' => 'InvalidDatabasePropertyValue', 'errorMessage' => 'Specified value for the database property is not valid.', ], [ 'errorCode' => 'InvalidDatabaseProperty', 'errorMessage' => 'Specified name for the database property is not valid.', ], [ 'errorCode' => 'DatabasePropertyModificationFail', 'errorMessage' => 'Database property modification failed, possibly due to high workload on the database or inability to obtain an exclusive lock. Please attempt to modify the property during periods of low workload.', ], [ 'errorCode' => 'InvalidDatabaseVersion', 'errorMessage' => 'Specified database property is not compatible with the SQL Server major version.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'UserAlreadyExistInDb', 'errorMessage' => 'The current login already has a mapped user with the same name in the specific database. please try removing the existing user and retrying.', ], [ 'errorCode' => 'InvalidDiskType', 'errorMessage' => 'Current disk type does not support this operation.', ], [ 'errorCode' => 'CurrentInsHasColdDB', 'errorMessage' => 'The current instance has cold storage db.', ], [ 'errorCode' => 'CurrentInsHasColdStorage', 'errorMessage' => 'Current instance has cold storage.', ], [ 'errorCode' => 'ColdDBHasSameNameWithOnlineDB', 'errorMessage' => 'The instance has cold db and online db with the same name.', ], [ 'errorCode' => 'DiskSpaceInsufficientForColdOperation', 'errorMessage' => 'Insufficient disk space to bring db online.', ], [ 'errorCode' => 'InvalidRestoreTimeSpecified', 'errorMessage' => 'Unable to restore to the specified time, because the database is in cold storage at this time. Please choose a valid restore point.', ], [ 'errorCode' => 'InvalidRestoreDB', 'errorMessage' => 'Unable to restore, because the database is in cold storage now. Please skip this database.', ], [ 'errorCode' => 'CurrentDBIsInColdStorage', 'errorMessage' => 'current db is cold db.', ], [ 'errorCode' => 'ColdDBNumExceedsLimit', 'errorMessage' => 'the number of cold db exceeds the limit.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'InvalidCharacter.DbOrAccount', 'errorMessage' => 'The database name or account name contains invalid characters.', ], [ 'errorCode' => 'StatisticsUpdateNotSupported', 'errorMessage' => 'Updating statistics is not supported.', ], ], 403 => [ [ 'errorCode' => 'InvalidDB.NotFound', 'errorMessage' => 'Specified db does not exist or DB status does not support.', ], [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 409 => [ [ 'errorCode' => 'ConflictingDatabaseOperation', 'errorMessage' => 'There is already some operation on the database and the current operation should wait till it is done.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"F5C79A20-E931-5389-BC04-DEBA2D3ABD8D\\"\\n}","type":"json"}]', 'title' => 'ModifyDatabaseConfig', 'description' => '### [](#)Supported database engine'."\n" ."\n" .'* SQL Server'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'You can call this operation to modify the database properties of an ApsaraDB RDS for SQL Server instance and archive data from an instance that uses cloud disks to an Object Storage Service (OSS) bucket. Before you call this operation to archive data to an OSS bucket, you must enable the data archiving feature in the ApsaraDB RDS console. For more information, see [Modify database properties](~~2401398~~) and [Archive cloud disk data to an OSS bucket](~~2767189~~).'."\n" ."\n" .'> Before you call this operation, read the following topics and make sure that you fully understand the prerequisites and impacts of this operation.'."\n", 'requestParamsDescription' => '## Native parameters in SQL Server'."\n" ."\n" .'|Parameter|Valid value|Exclusive lock required on the database to change the value|Minimum version of SQL Server|'."\n" .'|:---|:---|:---|:---|'."\n" .'|compatibility\\_level|100110120130140150160|No|SQL Server 2008|'."\n" .'|parameterization|FORCEDSIMPLE|No|All|'."\n" .'|delayed\\_durability|DISABLEDALLOWEDFORCED|No|SQL Server 2014|'."\n" .'|accelerated\\_database\\_recovery|ONOFF|Yes|SQL Server 2019|'."\n" .'|read\\_committed\\_snapshot|ONOFF|Yes|SQL Server 2008|'."\n" .'|page\\_verify|CHECKSUMTORN\\_PAGE\\_DETECTION. You cannot change the value to TORN\\_PAGE\\_DETECTION.|No|All|'."\n" .'|auto\\_update\\_statistics|ONOFF|No|All|'."\n" .'|auto\\_update\\_statistics\\_async|ONOFF|No|SQL Server 2012|'."\n" .'|allow\\_snapshot\\_isolation|ONOFF|No|All|'."\n" .'|ansi\\_null\\_default|ONOFF|No|All|'."\n" .'|ansi\\_nulls|ONOFF|No|All|'."\n" .'|ansi\\_warnings|ONOFF|No|All|'."\n" .'|ansi\\_padding|ONOFF|No|All|'."\n" .'|concat\\_null\\_yields\\_null|ONOFF|No|All|'."\n" .'|recursive\\_triggers|ONOFF|No|All|'."\n" .'|auto\\_close|OFF|No|All|'."\n" ."\n" .'## Custom parameters of ApsaraDB RDS'."\n" ."\n" .'**Note** The custom parameters of ApsaraDB RDS start with rds\\_.'."\n" ."\n" .'|Parameter|Valid value|Exclusive lock required on the database to change the value|Minimum version of SQL Server|Description|'."\n" .'|:---|:---|:---|:---|:---|'."\n" .'|rds\\_optimize\\_db\\_file\\_grow|1|No|All|The incremental size of all database files. Value: 256. Unit: MB.|'."\n" .'|rds\\_set\\_db\\_online|1|No|All|Specifies whether to change the status of the database to Online. If the database is in the Online state, ignore this parameter.|'."\n" .'|rds\\_shrink\\_database\\_log|1|No|All|When the shrinkage operation is performed on the database, whether the shrinkage is successful depends on whether log\\_resue\\_wait\\_desc of the log is set to Nothing.|'."\n" .'|rds\\_update\\_db\\_stats|1|No|All|When the statistics in the database is updated, the underlying layer uses the sp\\_updatestats stored procedure that is built in SQL Server.|'."\n" .'|rds\\_rebuild\\_db\\_index|1|No|All|If you want to update all non-clustered indexes whose fragmentation rate is greater than 50% in the database, make sure that the following conditions are met:\\-The database size is less than 10 GB.\\-The remaining disk space is greater than 10 GB.|', ], 'ModifyCollationTimeZone' => [ 'summary' => 'Modifies the character set collation and time zone of system databases on an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-uf6wjk5xxxxxxx', ], ], [ 'name' => 'Collation', 'in' => 'query', 'schema' => [ 'description' => 'The character set collation of the instance. By default, the system does not modify the character set collation of the instance. Valid values:'."\n" ."\n" .'* **Chinese_PRC_CI_AS**'."\n" .'* **Chinese_PRC_CS_AS**'."\n" .'* **Chinese_PRC_BIN**'."\n" .'* **Latin1\\_General_CI_AS**'."\n" .'* **Latin1\\_General_CS_AS**'."\n" .'* **SQL_Latin1\\_General_CP1\\_CI_AS**'."\n" .'* **SQL_Latin1\\_General_CP1\\_CS_AS**'."\n" .'* **Japanese_CI_AS**'."\n" .'* **Japanese_CS_AS**'."\n" .'* **Chinese_Taiwan_Stroke_CI_AS**'."\n" .'* **Chinese_Taiwan_Stroke_CS_AS**'."\n" ."\n" .'> * The default character set collation of the instance is **Chinese_PRC_CI_AS**.'."\n" .'> * You must specify one of the **Collation** and **Timezone** parameters.', 'type' => 'string', 'required' => false, 'example' => 'Latin1_General_CI_AS', ], ], [ 'name' => 'Timezone', 'in' => 'query', 'schema' => [ 'description' => 'The time zone of the instance. By default, the system does not modify the time zone.'."\n" ."\n" .'> * The default time zone of the instance is **China Standard Time**.'."\n" .'> * You must specify one of the **Collation** and **Timezone** parameters.', 'type' => 'string', 'required' => false, 'example' => 'China Standard Time', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Collation' => [ 'description' => 'The character set collation of the instance.'."\n", 'type' => 'string', 'example' => 'Latin1_General_CI_AS', ], 'DBInstanceId' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5xxxxxxx', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '8EA054AF-DFA7-497D-9F57-790FFC974C0B', ], 'TaskId' => [ 'description' => 'The task ID.'."\n", 'type' => 'string', 'example' => '114413215', ], 'Timezone' => [ 'description' => 'The time zone.'."\n", 'type' => 'string', 'example' => 'China Standard Time', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => '%s', 'errorMessage' => 'DB Operation Failed:%s.', ], [ 'errorCode' => 'SqlExcutionFailed', 'errorMessage' => 'Database is already open and can only have one user at a time.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'The database instance type does not support the operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Collation\\": \\"Chinese_PRC_CS_AS\\",\\n \\"DBInstanceId\\": \\"rm-bp15qi0nd1u27****\\",\\n \\"RequestId\\": \\"58D48758-F035-52D3-A4FB-80C73DA3E95C\\",\\n \\"TaskId\\": \\"56365****\\",\\n \\"Timezone\\": \\"China Standard Time\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n\\tLatin1_General_CI_AS\\r\\n\\trm-bp1yx1dv50269syxa\\r\\n\\t8EA054AF-DFA7-497D-9F57-790FFC974C0B\\r\\n\\t114413215\\r\\n\\tnochange","errorExample":""}]', 'title' => 'ModifyCollationTimeZone', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'RDS SQL Server'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> Before you call this operation, read the following topics and make sure that you fully understand the prerequisites and impacts of this operation.'."\n" ."\n" .'[Change the character set collation and the time zone of system databases](~~95700~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeDatabases' => [ 'summary' => 'Queries the details about the databases on an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5****', ], ], [ 'name' => 'DBName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testDB01', ], ], [ 'name' => 'DBStatus', 'in' => 'query', 'schema' => [ 'description' => 'The status of the database. Valid values:'."\n" ."\n" .'* **Creating**'."\n" .'* **Running**'."\n" .'* **Deleting**'."\n", 'type' => 'string', 'required' => false, 'example' => 'Creating', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return per page. Valid values:'."\n" ."\n" .'* **30**'."\n" .'* **50**'."\n" .'* **100**'."\n" ."\n" .'Default value: 30.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '0', 'example' => '30', 'default' => '0', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => 'The page number. Pages start from 1.'."\n" ."\n" .'Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '0', 'example' => '1', 'default' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Databases' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Database' => [ 'description' => 'The information about the databases.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Accounts' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'AccountPrivilegeInfo' => [ 'description' => 'The information about the account. Each account has specific permissions on the database.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Account' => [ 'description' => 'The account username.'."\n", 'type' => 'string', 'example' => 'test', ], 'AccountPrivilege' => [ 'description' => 'The permissions that the account has on the database. Valid values:'."\n" ."\n" .'* **ReadWrite**: read and write permissions'."\n" .'* **ReadOnly**: read-only permissions'."\n" .'* **DMLOnly**: DML-only permissions'."\n" .'* **DDLOnly**: DDL-only permissions'."\n", 'type' => 'string', 'example' => 'DMLOnly', ], 'AccountPrivilegeDetail' => [ 'description' => 'The permission that the account has on the database.'."\n", 'type' => 'string', 'example' => 'SELECT', ], ], ], ], ], ], 'AdvancedInfo' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'AdvancedDbProperty' => [ 'description' => 'The advanced information about the database.'."\n" ."\n" .'> This parameter is returned only for instances that run SQL Server.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details of the advanced information about the database.'."\n", 'type' => 'object', 'example' => '{'."\n" .' "allowedValues": ['."\n" .' "OFF",'."\n" .' "ON"'."\n" .' ],'."\n" .' "databasePropertyName": "ansi_nulls",'."\n" .' "allowModify": true,'."\n" .' "excludeLock": "0",'."\n" .' "currentValue": "OFF"'."\n" .'}', ], ], ], ], 'BasicInfo' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'BasicDbProperty' => [ 'description' => 'The basic information about the database.'."\n" ."\n" .'> This parameter is returned only for instances that run SQL Server.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details of the basic information about the database.'."\n", 'type' => 'object', 'example' => '{'."\n" .' "allowedValues": ['."\n" .' "CHECKSUM"'."\n" .' ],'."\n" .' "databasePropertyName": "page_verify",'."\n" .' "allowModify": true,'."\n" .' "excludeLock": "0",'."\n" .' "currentValue": "CHECKSUM"'."\n" .'}', ], ], ], ], 'CharacterSetName' => [ 'description' => 'The name of the character set.'."\n", 'type' => 'string', 'example' => 'utf8', ], 'Collate' => [ 'description' => 'The collation of the character set. The example value C indicates localization.'."\n" ."\n" .'> This parameter is returned only for instances that run PostgreSQL.'."\n", 'type' => 'string', 'example' => 'C', ], 'ConnLimit' => [ 'description' => 'The limit on the number of concurrent requests. The value -1 indicates that the number of concurrent requests is unlimited.'."\n" ."\n" .'> This parameter is returned only for instances that run PostgreSQL.'."\n", 'type' => 'string', 'example' => '-1', ], 'Ctype' => [ 'description' => 'The type of the character set.'."\n" ."\n" .'> This parameter is returned only for instances that run PostgreSQL.'."\n", 'type' => 'string', 'example' => 'en_US.utf8', ], 'DBDescription' => [ 'description' => 'The description of the database.'."\n", 'type' => 'string', 'example' => 'testdb', ], 'DBInstanceId' => [ 'description' => 'The ID of the instance to which the database belongs.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5****', ], 'DBName' => [ 'description' => 'The database name.'."\n", 'type' => 'string', 'example' => 'testDB01', ], 'DBStatus' => [ 'description' => 'The database status. Valid values:'."\n" ."\n" .'* **Creating**'."\n" .'* **Running**'."\n" .'* **Deleting**'."\n" .'* **Cold**'."\n", 'type' => 'string', 'example' => 'Creating', ], 'Engine' => [ 'description' => 'The database engine of the instance.'."\n", 'type' => 'string', 'example' => 'MySQL', ], 'PageNumber' => [ 'description' => 'The page number of the page to return.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', ], 'RuntimeInfo' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'RuntimeDbProperty' => [ 'description' => 'The runtime information about the database.'."\n" ."\n" .'> This parameter is returned only for instances that run SQL Server.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details of the runtime information about the database.'."\n", 'type' => 'object', 'example' => '{'."\n" .' "allowedValues": [],'."\n" .' "databasePropertyName": "TotalDataSizeInMB",'."\n" .' "allowModify": false,'."\n" .' "currentValue": "5.38"'."\n" .'}', ], ], ], ], 'Tablespace' => [ 'description' => 'The database tablespace.'."\n" ."\n" .'> This parameter is returned only for instances that run PostgreSQL.'."\n", 'type' => 'string', 'example' => 'pg_default', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n" ."\n" .'> This parameter is returned only for instances that run SQL Server.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'DuckDBEnabled' => [ 'type' => 'boolean', ], ], ], ], ], ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '2603CA96-B17D-4903-BC04-61A2C829CD94', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => '%s', 'errorMessage' => 'DB Operation Failed:%s.', ], [ 'errorCode' => 'Database.ConnectError', 'errorMessage' => 'Database connect error. please check instance status and database processlist', ], [ 'errorCode' => 'InvalidDBInstanceStatus.NotSupport', 'errorMessage' => 'The Specified instance status is not supported to query account list.', ], [ 'errorCode' => 'Database.QueryError', 'errorMessage' => 'Query Db failed, please check input value and instance status.', ], [ 'errorCode' => 'SqlExcutionFailed', 'errorMessage' => 'Database is in transition. Try the statement later.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ConcurrentLimit', 'errorMessage' => 'The request processing has been concurrent limit.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'InvalidCharacter.DbOrAccount', 'errorMessage' => 'The database name or account name contains invalid characters.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 408 => [ [ 'errorCode' => 'NetworkOrSqlTimeoutError', 'errorMessage' => 'Failed to create login due to potential SQL Server overload or other issues that may cause the login creation fail. Please retry later.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Databases\\": {\\n \\"Database\\": [\\n {\\n \\"Accounts\\": {\\n \\"AccountPrivilegeInfo\\": [\\n {\\n \\"Account\\": \\"test\\",\\n \\"AccountPrivilege\\": \\"DMLOnly\\",\\n \\"AccountPrivilegeDetail\\": \\"SELECT\\"\\n }\\n ]\\n },\\n \\"AdvancedInfo\\": {\\n \\"AdvancedDbProperty\\": [\\n {\\n \\"allowedValues\\": [\\n \\"OFF\\",\\n \\"ON\\"\\n ],\\n \\"databasePropertyName\\": \\"ansi_nulls\\",\\n \\"allowModify\\": true,\\n \\"excludeLock\\": \\"0\\",\\n \\"currentValue\\": \\"OFF\\"\\n }\\n ]\\n },\\n \\"BasicInfo\\": {\\n \\"BasicDbProperty\\": [\\n {\\n \\"allowedValues\\": [\\n \\"CHECKSUM\\"\\n ],\\n \\"databasePropertyName\\": \\"page_verify\\",\\n \\"allowModify\\": true,\\n \\"excludeLock\\": \\"0\\",\\n \\"currentValue\\": \\"CHECKSUM\\"\\n }\\n ]\\n },\\n \\"CharacterSetName\\": \\"utf8\\",\\n \\"Collate\\": \\"C\\",\\n \\"ConnLimit\\": \\"-1\\",\\n \\"Ctype\\": \\"en_US.utf8\\",\\n \\"DBDescription\\": \\"testdb\\",\\n \\"DBInstanceId\\": \\"rm-uf6wjk5****\\",\\n \\"DBName\\": \\"testDB01\\",\\n \\"DBStatus\\": \\"Creating\\",\\n \\"Engine\\": \\"MySQL\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"RuntimeInfo\\": {\\n \\"RuntimeDbProperty\\": [\\n {\\n \\"allowedValues\\": [],\\n \\"databasePropertyName\\": \\"TotalDataSizeInMB\\",\\n \\"allowModify\\": false,\\n \\"currentValue\\": \\"5.38\\"\\n }\\n ]\\n },\\n \\"Tablespace\\": \\"pg_default\\",\\n \\"TotalCount\\": 5,\\n \\"DuckDBEnabled\\": true\\n }\\n ]\\n },\\n \\"RequestId\\": \\"2603CA96-B17D-4903-BC04-61A2C829CD94\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"7463B73D-35CC-4D19-A010-6B8D65D242EF\\",\\n \\"HostId\\": \\"rds.aliyuncs.com\\",\\n \\"Code\\": \\"UnsupportedOperation\\",\\n \\"Message\\": \\"The specified action is not supported.\\"\\n}"},{"type":"xml","example":"\\n\\n\\t2603CA96-B17D-4903-BC04-61A2C829CD94\\n\\t\\n\\t\\t\\n\\t\\t\\tMySQL\\n\\t\\t\\tutf8\\n\\t\\t\\tCreating\\n\\t\\t\\t\\n\\t\\t\\trdsaiiabnaiiabn\\n\\t\\t\\t\\n\\t\\t\\ttestdb\\n\\t\\t\\n\\t\\t\\n\\t\\t\\tMySQL\\n\\t\\t\\tgbk\\n\\t\\t\\tCreating\\n\\t\\t\\t\\n\\t\\t\\trdsaiiabnaiiabn\\n\\t\\t\\t\\n\\t\\t\\ttestdb2\\n\\t\\t\\n\\t\\n\\t\\n","errorExample":""}]', 'title' => 'DescribeDatabases', 'description' => '### Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" .'* MariaDB'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeCollationTimeZones' => [ 'summary' => 'Queries the character set collations and time zones that are available for use in ApsaraDB RDS for SQL Server.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'CollationTimeZones' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'CollationTimeZone' => [ 'description' => 'The list of the character set collations and time zones that are available.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Description' => [ 'description' => 'The description.'."\n", 'type' => 'string', 'example' => 'Kabul', ], 'StandardTimeOffset' => [ 'description' => 'The offset of the UTC time. The offset is in the following format: (UTC+*HH:mm*).'."\n", 'type' => 'string', 'example' => '(UTC+04:30)', ], 'TimeZone' => [ 'description' => 'The time zone.'."\n", 'type' => 'string', 'example' => 'Afghanistan Standard Time', ], ], ], ], ], ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '4EAED246-DB18-4C8D-9EB5-C319626F2A77', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"CollationTimeZones\\": {\\n \\"CollationTimeZone\\": [\\n {\\n \\"Description\\": \\"Kabul\\",\\n \\"StandardTimeOffset\\": \\"(UTC+04:30)\\",\\n \\"TimeZone\\": \\"Afghanistan Standard Time\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"4EAED246-DB18-4C8D-9EB5-C319626F2A77\\"\\n}","errorExample":""},{"type":"xml","example":"\\n\\n\\t\\n\\t\\t\\n\\t\\t\\t(UTC+04:30)\\n\\t\\t\\tKabul\\n\\t\\t\\tAfghanistan Standard Time\\n\\t\\t\\n\\t\\n\\t4EAED246-DB18-4C8D-9EB5-C319626F2A77\\n","errorExample":""}]', 'title' => 'DescribeCollationTimeZones', 'description' => '### Supported database engine'."\n" ."\n" .'SQL Server'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeCharacterSetName' => [ 'summary' => 'Queries the character sets that are supported by an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'Engine', 'in' => 'query', 'schema' => [ 'description' => 'The type of the database engine. Valid values:'."\n" ."\n" .'* **mysql**'."\n" .'* **mssql**'."\n" .'* **PostgreSQL**'."\n" .'* **MariaDB**'."\n", 'type' => 'string', 'required' => true, 'example' => 'mysql', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The resource group ID. You can call the DescribeDBInstanceAttribute operation to query the resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy*****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'CharacterSetNameItems' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'CharacterSetName' => [ 'description' => 'The character sets that are supported.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The character set that is supported.'."\n", 'type' => 'string', 'example' => 'gbk', ], ], ], ], 'Engine' => [ 'description' => 'The type of the database engine.'."\n", 'type' => 'string', 'example' => 'mysql', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidEngine.Malformed', 'errorMessage' => 'Specified engine is not valid.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"CharacterSetNameItems\\": {\\n \\"CharacterSetName\\": [\\n \\"[\\\\\\"gbk\\\\\\",\\\\\\"utf8\\\\\\",\\\\\\"euckr\\\\\\",\\\\\\"ascii\\\\\\"]\\"\\n ]\\n },\\n \\"Engine\\": \\"mysql\\",\\n \\"RequestId\\": \\"1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC\\"\\n}","errorExample":""},{"type":"xml","example":"1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC\\n\\n [\\"gbk\\",\\"utf8\\",\\"euckr\\",\\"ascii\\"]\\n\\nmysql","errorExample":""}]', 'title' => 'DescribeCharacterSetName', 'description' => '### Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" .'* MariaDB'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'CopyDatabaseBetweenInstances' => [ 'summary' => 'Replicates databases between RDS SQL Server instances.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The source instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5xxxxxxx', ], ], [ 'name' => 'TargetDBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The destination instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-ut5ajk3xxxxxxx', ], ], [ 'name' => 'DbNames', 'in' => 'query', 'schema' => [ 'description' => 'The names of the databases that you want to copy. Format: `Source database name 1,Source database name 2`.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"test1":"newtest1","test2":"newtest2"}', ], ], [ 'name' => 'BackupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the backup set based on which you want to restore databases of the source instance. When you replicate databases by backup set, you can call the DescribeBackups operation to obtain the ID of the backup set.'."\n" ."\n" .'> You must specify one of the **BackupId** and **RestoreTime** parameters.'."\n", 'type' => 'string', 'required' => false, 'example' => '106523874****', ], ], [ 'name' => 'RestoreTime', 'in' => 'query', 'schema' => [ 'description' => 'The point in time when the system replicates databases. You can select a point in time within the backup retention period. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time must be in UTC.'."\n" ."\n" .'> You must specify one of the **BackupId** and **RestoreTime** parameters.'."\n", 'type' => 'string', 'required' => false, 'example' => '2011-06-11T16:00:00Z', ], ], [ 'name' => 'SyncUserPrivilege', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to copy users and permissions.'."\n" ."\n" .'* **YES**: copies users and permissions. If the destination instance has a user whose name is the same as a user in the source instance, the permissions of the user in the source instance will also be granted to the user in the destination instance after you copy user permissions.'."\n" .'* **NO**: does not copy users and permissions.'."\n" ."\n" .'Default value: **NO**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'NO', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '803D11AF-C370-465B-AB46-CB3A642DC303', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => '%s', 'errorMessage' => 'DB Operation Failed:%s.', ], [ 'errorCode' => 'InvalidBackupSetID', 'errorMessage' => 'Invalid backup set id.', ], [ 'errorCode' => 'DBCountLimitExceeded', 'errorMessage' => 'Db count limit exceeded.', ], [ 'errorCode' => 'BackupRestoreNotSupported.BasicHA', 'errorMessage' => 'Basic instances cannot be restored to high availability instances, and high availability instances cannot be restored to basic instances.', ], [ 'errorCode' => 'BackupRestoreNotSupported.HADedicatedAlwaysOn', 'errorMessage' => 'High availability instances cannot be restored to dedicated cluster instances or AlwaysOn instances.', ], [ 'errorCode' => 'BackupRestoreNotSupported.ShareDedicatedAlwaysOn', 'errorMessage' => 'Shared instances cannot be restored to dedicated cluster instances, AlwaysOn instances, or high availability instances.', ], [ 'errorCode' => 'OperationDenied.RestoreTime', 'errorMessage' => 'The instance with snapshot backup enabled can only be restored to the instance with snapshot backup enabled.', ], [ 'errorCode' => 'OperationDenied.SnapshotBackupSet', 'errorMessage' => 'Snapshot backup set can only be restored to the instance with snapshot backup enabled.', ], [ 'errorCode' => 'CanNotCopyDBHasTDEEnabled', 'errorMessage' => 'The source database has enabled the TDE feature. You cannot copy it to another instance.', ], [ 'errorCode' => 'InvalidBackupDBNames.NotFound', 'errorMessage' => 'The specified BackupDBNames is not found.', ], [ 'errorCode' => 'InvalidBackupDBNames.Malformed', 'errorMessage' => 'The specified backup database is not valid.', ], [ 'errorCode' => 'InvalidDBName.Format', 'errorMessage' => 'Specified DB name is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'Invalid DBInstanceId NotFound.', ], [ 'errorCode' => 'EngineNotSupported', 'errorMessage' => 'The engine does not support the operation.', ], [ 'errorCode' => 'InvalidTargetDBInstanceName.Format', 'errorMessage' => 'Specified Target DB instance name is not valid.', ], [ 'errorCode' => 'MasterDBInstanceState.NotSupport', 'errorMessage' => 'The Master instance state does not support this operation.', ], [ 'errorCode' => 'TargetInstanceEngineNotSupported', 'errorMessage' => 'The specified Engine cannot be supported the operation.', ], [ 'errorCode' => 'InvalidInstancesRegion.Malformed', 'errorMessage' => 'The instance region is not the same as the target instance region.', ], [ 'errorCode' => 'InvalidStartTime.Format', 'errorMessage' => 'The specified parameter "StartTime" is not valid.', ], [ 'errorCode' => 'InvalidEndTime.Format', 'errorMessage' => 'The specified parameter "EndTime" is not valid.', ], [ 'errorCode' => 'InvalidParameterCombination', 'errorMessage' => 'The end time must be greater than the start time', ], [ 'errorCode' => 'InvalidBackupSetLocation.Format', 'errorMessage' => 'Specified backup set location is not valid.', ], [ 'errorCode' => 'InvalidCrossRegionTrans', 'errorMessage' => 'Cross region instance trans is not supported', ], [ 'errorCode' => 'ErrorParametersConflict', 'errorMessage' => 'Parameter BackupsetID and restoretime can only exist one.', ], [ 'errorCode' => 'InvalidDBName.NotFound', 'errorMessage' => 'Specified DB name does not exist.', ], [ 'errorCode' => 'InvalidDBName.Duplicate', 'errorMessage' => 'Specified DB name already exists in the This instance.', ], [ 'errorCode' => 'ReadDBInstanceNotSupport', 'errorMessage' => 'The operation is not permitted due to type of the instance.', ], [ 'errorCode' => 'InvalidRecoveryDbInstance.StorageSize', 'errorMessage' => 'The disk space of the new instance cannot be less than that of the current instance', ], [ 'errorCode' => 'InvalidRecoveryDBNames.Format', 'errorMessage' => 'The specified parameter DBNames is not valid.', ], [ 'errorCode' => 'InvalidBackupIdOrRestoreTime.NotFound', 'errorMessage' => 'The specified parameter BackupId or RestoreTime is not valid.', ], [ 'errorCode' => 'Forbidden.RegionNotFound', 'errorMessage' => 'The provided RegionId does not exist in our record.', ], [ 'errorCode' => 'ImageNotFound', 'errorMessage' => 'The specified Image is disabled or is deleted.', ], [ 'errorCode' => 'InvalidZone.NotSupportedForStorageType', 'errorMessage' => 'The specified zone is closed or invalid for Specified DBInstanceStorageType.', ], [ 'errorCode' => 'InvalidEngineOrEngineVersion', 'errorMessage' => 'The specified params engine or engineVersion should not be null.', ], [ 'errorCode' => 'InvalidGeneralGroupNameOrGdnInstanceName', 'errorMessage' => 'The specified params generalGroupName or gdnInstanceName should not be null.', ], [ 'errorCode' => 'InvalidVSwitchId.NotFound', 'errorMessage' => 'Specified virtual switch is not found in specified VPC.', ], [ 'errorCode' => 'CDDC.TargetHostIDNotAvailable', 'errorMessage' => 'The target host ID is not available.', ], [ 'errorCode' => 'CDDC.AvailableHostsNotEnoughInZone', 'errorMessage' => 'Not enough available hosts are in the target zone.', ], [ 'errorCode' => 'ReadOnlyInstanceNotSupport', 'errorMessage' => 'Specified ReadOnly Instance not support this operation.', ], [ 'errorCode' => 'InvalidShareDbInstanceClassNotSupport', 'errorMessage' => 'The current instance classType is not support operation.', ], [ 'errorCode' => 'InvalidQuantity.NotSupported', 'errorMessage' => 'The specified instance quantity is not supported.', ], [ 'errorCode' => 'IncorrectMasterDBInstanceState', 'errorMessage' => 'Master instance state does not support this operation.', ], [ 'errorCode' => 'InvalidDBInstance.ReadDBInstanceExceeded', 'errorMessage' => 'Current DB Instance exceeding the allowed amount of read instance.', ], [ 'errorCode' => 'InvalidEngineVersion.Malformed', 'errorMessage' => 'Specified engine version is not valid.', ], [ 'errorCode' => 'InvalidEssdStorageSize', 'errorMessage' => 'The cloud ESSD storage size is invalid.', ], [ 'errorCode' => 'IncorrectInstanceNetworkType', 'errorMessage' => 'The specified parameter InstanceNetworkType is not valid.', ], [ 'errorCode' => 'AtLeastTwoVSwitchParamExists', 'errorMessage' => 'The specified params(Vswitchs) at least two.', ], [ 'errorCode' => 'InvalidIzNo.NotSupported', 'errorMessage' => 'Specified VPC zone is not supported.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'Specified database does not exists in the backup set.', ], [ 'errorCode' => 'InvalidRestoreTimeSpecified', 'errorMessage' => 'Unable to restore to the specified time, because the database is in cold storage at this time. Please choose a valid restore point.', ], [ 'errorCode' => 'InvalidRestoreDB', 'errorMessage' => 'Unable to restore, because the database is in cold storage now. Please skip this database.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'InvalidCharacter.DbOrAccount', 'errorMessage' => 'The database name or account name contains invalid characters.', ], ], 403 => [ [ 'errorCode' => 'StorageLimitExceeded', 'errorMessage' => 'Exceeding the allowed Storage of DB instance.', ], [ 'errorCode' => 'InvalidTempInstance.NotSupport', 'errorMessage' => 'The temp db Instance is not support.', ], [ 'errorCode' => 'InvalidTargetDBInstanceName.Format', 'errorMessage' => 'Specified Target DB instance name is not valid.', ], [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'The current database instance state does not support the operation.', ], [ 'errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance engine and type does not support operations.', ], [ 'errorCode' => 'Forbidden.SnapshotRecovery', 'errorMessage' => 'Snapshot backup does not support partial restore', ], [ 'errorCode' => 'OperationDenied.Resource', 'errorMessage' => 'Specified DB instance class or storage is not available in all Availability Zones.', ], [ 'errorCode' => 'ReadonlyDBInstanceStorageExceeded', 'errorMessage' => 'You can not create the order with the db instance because The masterInstance storage value exceeding the readonlyInstance storage value.', ], [ 'errorCode' => 'MasterDBInstanceClassNotSupport', 'errorMessage' => 'You can not create the readonly instance with the master instance class does not support.', ], [ 'errorCode' => 'ReadonlyDBInstanceClassNotSupport', 'errorMessage' => 'You can not create the readonly instance with the instance class does not support.', ], [ 'errorCode' => 'ReadonlyDBInstanceClassLowerThanMasterInstance', 'errorMessage' => 'The readonly instance db instance class are lower than master instance db instance class.', ], [ 'errorCode' => 'InvalidSwitchType.Malformed', 'errorMessage' => 'The specified parameter InvalidSwitchType is not valid.', ], [ 'errorCode' => 'UnsupportedCopyDbHighAvailabilityToBasic', 'errorMessage' => 'Replicate Database from RDS Category:HighAvailability to RDS Category:Basic is not supported.', ], [ 'errorCode' => 'InvalidInstanceVersion', 'errorMessage' => 'Source instance version is greater than the target instance version.', ], [ 'errorCode' => 'UnsupportedCopyDbShareToHighAvailability', 'errorMessage' => 'Replicate Database from RDS Category:Share to RDS Category:HighAvailability is not supported.', ], [ 'errorCode' => 'UnsupportedCopyDbAlwaysOnToBasic', 'errorMessage' => 'Replicate Database from RDS Category:AlwaysOn to RDS Category:Basic is not supported.', ], [ 'errorCode' => 'UnsupportedCopyDbBasicToShare', 'errorMessage' => 'Replicate Database from RDS Category:Basic to RDS Category:Share is not supported.', ], [ 'errorCode' => 'UnsupportedCopyDbAlwaysOnToHighAvailability', 'errorMessage' => 'Replicate Database from RDS Category:AlwaysOn to RDS Category:HighAvailability is not supported.', ], [ 'errorCode' => 'UnsupportedCopyDbShareToBasic', 'errorMessage' => 'Replicate Database from RDS Category:Share to RDS Category:Basic is not supported.', ], [ 'errorCode' => 'UnsupportedCopyDbHighAvailabilityToShare', 'errorMessage' => 'Replicate Database from RDS Category:HighAvailability to RDS Category:Share is not supported.', ], [ 'errorCode' => 'UnsupportedCopyDbShareToAlwaysOn', 'errorMessage' => 'Replicate Database from RDS Category:Share to RDS Category:AlwaysOn is not supported.', ], [ 'errorCode' => 'UnsupportedCopyDbAlwaysOnToShare', 'errorMessage' => 'Replicate Database from RDS Category:AlwaysOn to RDS Category:Share is not supported.', ], [ 'errorCode' => 'InvalidParamTableMeta.RestoreTime', 'errorMessage' => 'The specified restore time cannot be covered by the existing backup chain. Please try specifying a different restore time.', ], [ 'errorCode' => 'CurrentRecoveryModelNotSupportThisAction', 'errorMessage' => 'Current recovery model not supported this action.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance does not exist or is not supported.', ], [ 'errorCode' => 'StorageLimitExceeded', 'errorMessage' => 'Exceeding the allowed Storage of DB instance.', ], [ 'errorCode' => 'InvalidInstanceStorageType.NotFound', 'errorMessage' => 'The specified DBInstanceStorageType is not found.', ], [ 'errorCode' => 'InvalidRegion.NotFound', 'errorMessage' => 'Specified Region does not exist in the RDS', ], [ 'errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', ], [ 'errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'Current cluster resources are insufficient. Try again later.', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Invalid params to call rds open api, BakDBNames is not empty.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 408 => [ [ 'errorCode' => 'NetworkOrSqlTimeoutError', 'errorMessage' => 'Failed to create login due to potential SQL Server overload or other issues that may cause the login creation fail. Please retry later.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"803D11AF-C370-465B-AB46-CB3A642DC303\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 803D11AF-C370-465B-AB46-CB3A642DC303\\n","errorExample":""}]', 'title' => 'CopyDatabaseBetweenInstances', 'description' => '### Supported database engines'."\n" ."\n" .'RDS SQL Server'."\n" ."\n" .'### References'."\n" ."\n" .'> : Before you call this operation, read the following documentation and make sure that you fully understand the prerequisites and impacts of this operation.'."\n" ."\n" .'[Replicate databases between ApsaraDB RDS for SQL Server instances](~~95702~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'CheckDBNameAvailable' => [ 'summary' => 'Checks whether a database name is unique and conforms to the naming conventions on an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxxxxx', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-t4n3axxxxx', ], ], [ 'name' => 'DBName', 'in' => 'query', 'schema' => [ 'description' => 'The database name that you want to check.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n" ."\n" .'> If this operation returns only the ID of the request, the database name conforms to the naming conventions. If an error message is returned, the database name is duplicate or does not conform to the naming conventions.'."\n", 'type' => 'string', 'example' => '6EF82B07-28D2-48D1-B5D6-7E78FED277C7', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Database.ConnectError', 'errorMessage' => 'Database connect error. please check instance status and database processlist', ], [ 'errorCode' => 'Database.QueryError', 'errorMessage' => 'invalid value, may include special character.', ], [ 'errorCode' => 'InvalidDBName.Format', 'errorMessage' => 'Specified DB name is not valid.', ], [ 'errorCode' => 'InvalidDBName.Forbid', 'errorMessage' => 'Specified DB name is a keyword in RDS.', ], [ 'errorCode' => 'InvalidDBName.Duplicate', 'errorMessage' => 'Specified DB name already exists in the This instance.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance engine and type does not support operations.', ], [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'Invalid DBInstanceId NotFound.', ], [ 'errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6EF82B07-28D2-48D1-B5D6-7E78FED277C7\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n6EF82B07-28D2-48D1-B5D6-7E78FED277C7\\r\\n","errorExample":""}]', 'title' => 'CheckDBNameAvailable', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* RDS MySQL'."\n" .'* RDS PostgreSQL'."\n" .'* RDS SQL Server'."\n" .'* RDS MariaDB'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'CreateReadOnlyDBInstance' => [ 'summary' => 'Creates a read-only instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'high', 'chargeType' => 'paid', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOC****', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. The read-only instance and the primary instance must reside in the same region. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'ZoneId', 'in' => 'query', 'schema' => [ 'description' => 'The zone ID. You can call the DescribeRegions operation to query the zone ID.'."\n" ."\n" .'* If you use the single-zone deployment method, set this parameter to the ID of one zone. Example: `cn-hangzhou-b`.'."\n" .'* If you use the multi-zone deployment method, set this parameter to the IDs of multiple zones and separate the IDs with colons (:). Example: `cn-hangzhou-b:cn-hangzhou-c`.'."\n" .'* The number of zone IDs that you specify must be less than or equal to the number of nodes created for the read-only instance. If you create a read-only instance that runs RDS Basic Edition, only one node is provisioned. If you create a read-only instance that runs RDS High-availability Edition, one primary node and one secondary node are provisioned.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou-b', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The primary instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5****', ], ], [ 'name' => 'DBInstanceClass', 'in' => 'query', 'schema' => [ 'description' => 'The instance type of the read-only instance. For more information, see [Read-only instance types](~~145759~~). We recommend that you specify an instance type whose specifications are higher than or equal to the specifications of the instance type of the primary instance. If the specifications of the read-only instance are lower than the specifications of the primary instance, the read-only instance may encounter issues such as high latency and heavy load.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rds.mys2.small', ], ], [ 'name' => 'DBInstanceStorage', 'in' => 'query', 'schema' => [ 'description' => 'The storage capacity of the read-only instance. The storage capacity of the read-only instance must be greater than or equal to that of the primary instance. For more information, see the **Storage capacity** column in [Read-only instance types](~~145759~~). This value must be a multiple of 5. Unit: GB.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '20', ], ], [ 'name' => 'EngineVersion', 'in' => 'query', 'schema' => [ 'description' => 'The version of the database engine. The read-only instance and the primary instance must run the same major engine version.'."\n" ."\n" .'* If the read-only instance runs MySQL, set this parameter to **5.6**, **5.7**, or **8.0**.'."\n" .'* If the read-only instance runs MySQL, set this parameter to **2017\\_ent, 2019\\_ent, or 2022\\_ent**.'."\n" .'* If the read-only instance runs PostgreSQL, set this parameter to **10.0, 11.0, 12.0, 13.0, 14.0, or 15.0**.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '5.6', ], ], [ 'name' => 'PayType', 'in' => 'query', 'schema' => [ 'description' => 'The billing method of the read-only instance. Valid values:'."\n" ."\n" .'* **Postpaid**: pay-as-you-go'."\n" .'* **Prepaid**: subscription'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Postpaid', ], ], [ 'name' => 'DBInstanceDescription', 'in' => 'query', 'schema' => [ 'description' => 'The description of the read-only instance. The description must be 2 to 256 characters in length and can contain letters, digits, underscores (\\_), and hyphens (-). The value must start with a letter'."\n" ."\n" .'> The value cannot start with [http:// or https://.](http://https://。)'."\n", 'type' => 'string', 'required' => false, 'example' => 'Test read-only instance'."\n", ], ], [ 'name' => 'InstanceNetworkType', 'in' => 'query', 'schema' => [ 'description' => 'The network type of the read-only instance. Valid values:'."\n" ."\n" .'* **VPC**'."\n" .'* **Classic**'."\n" ."\n" .'Default value: VPC. If you set this parameter to VPC, you must also specify the **VPCId** and **VSwitchId** parameters.'."\n" ."\n" .'> The network type of the read-only instance can be different from the network type of the primary instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Classic', 'default' => 'VPC', ], ], [ 'name' => 'VPCId', 'in' => 'query', 'schema' => [ 'description' => 'The virtual private cloud (VPC) ID of the read-only instance. If you leave the **InstanceNetworkType** parameter empty or set it to **VPC**, you must also specify this parameter.'."\n" ."\n" .'> * If the primary instance uses local disks, the read-only instance and the primary instance can belong to the same VPC or different VPCs.'."\n" .'> * If the primary instance uses cloud disks, the read-only instance and the primary instance must belong to the same VPC.', 'type' => 'string', 'required' => false, 'example' => 'vpc-uf6f7l4fg90****', ], ], [ 'name' => 'VSwitchId', 'in' => 'query', 'schema' => [ 'description' => 'The vSwitch ID of the read-only instance. If you leave the **InstanceNetworkType** parameter empty or set it to **VPC**, you must specify the VSwitchId parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vsw-uf6adz52c2p****', ], ], [ 'name' => 'PrivateIpAddress', 'in' => 'query', 'schema' => [ 'description' => 'The private IP address of the read-only instance. The private IP address must be within the CIDR block that is supported by the specified vSwitch. The system assigns a private IP address to the read-only instance based on the values of the **VPCId** and **VSwitchId** parameters.'."\n", 'type' => 'string', 'required' => false, 'example' => '172.16.XX.XX', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy****', ], ], [ 'name' => 'Category', 'in' => 'query', 'schema' => [ 'description' => 'The RDS edition of the instance. Valid values:'."\n" ."\n" .'* **Basic**: RDS Basic Edition'."\n" .'* **HighAvailability** (default): RDS High-availability Edition'."\n" .'* **AlwaysOn**: RDS Cluster Edition'."\n" ."\n" .'> The read-only instances of the primary instance that run PostgreSQL and use cloud disks run RDS Basic Edition. Therefore, set this parameter to **Basic**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'HighAvailability', 'default' => 'HighAvailability', ], ], [ 'name' => 'DBInstanceStorageType', 'in' => 'query', 'schema' => [ 'description' => 'The storage type of the instance. Valid values:'."\n" ."\n" .'* **local_ssd**: local SSDs'."\n" .'* **cloud_ssd**: standard SSDs'."\n" .'* **cloud_essd**: enhanced SSDs (ESSDs) of performance level 1 (PL1)'."\n" .'* **cloud_essd2**: ESSDs of PL2'."\n" .'* **cloud_essd3**: ESSDs of PL3'."\n" ."\n" .'> * If the primary instance runs MySQL with local disks, you must set this parameter to **local_ssd**. If the primary instance runs MySQL with cloud disks, you must set this parameter to cloud_ssd, cloud_essd, cloud_essd2, or cloud_essd3.'."\n" .'> * If the primary instance runs SQL Server, you must set this parameter to cloud_ssd, cloud_essd, cloud_essd2, or cloud_essd3.', 'type' => 'string', 'required' => false, 'example' => 'local_ssd', ], ], [ 'name' => 'DedicatedHostGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the dedicated cluster to which the read-only instance belongs. This parameter is valid when you create the read-only instance in a dedicated cluster.'."\n", 'type' => 'string', 'required' => false, 'example' => 'dhg-4n****', ], ], [ 'name' => 'TargetDedicatedHostIdForMaster', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the host on which the primary instance resides. This parameter is valid when you create the read-only instance in a dedicated cluster.'."\n", 'type' => 'string', 'required' => false, 'example' => 'i-bp****', ], ], [ 'name' => 'GdnInstanceName', 'in' => 'query', 'schema' => [ 'description' => 'A reserved parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'None'."\n", ], ], [ 'name' => 'TddlBizType', 'in' => 'query', 'schema' => [ 'description' => 'A reserved parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'None'."\n", ], ], [ 'name' => 'TddlRegionConfig', 'in' => 'query', 'schema' => [ 'description' => 'A reserved parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'None'."\n", ], ], [ 'name' => 'InstructionSetArch', 'in' => 'query', 'schema' => [ 'description' => 'A reserved parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'None'."\n", ], ], [ 'name' => 'UsedTime', 'in' => 'query', 'schema' => [ 'description' => 'The subscription duration of the read-only instance. Valid values:'."\n" ."\n" .'* If you set the **Period** parameter to **Year**, the value of the **UsedTime** parameter ranges from **1** to **5**.'."\n" .'* If you set the **Period** parameter to **Month**, the value of the **UsedTime** parameter ranges from **1** to **9**.'."\n" ."\n" .'> If you set the **PayType** parameter to **Prepaid**, you must specify the UsedTime parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => '1', ], ], [ 'name' => 'Period', 'in' => 'query', 'schema' => [ 'description' => 'The renewal cycle of the read-only instance. Valid values:'."\n" ."\n" .'* **Year**'."\n" .'* **Month**'."\n", 'type' => 'string', 'required' => false, 'example' => 'Month', ], ], [ 'name' => 'AutoRenew', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable the auto-renewal feature for the read-only instance. If you set the PayType parameter to Prepaid, you must also specify this parameter. Valid values:'."\n" ."\n" .'* **true**: enables the feature.'."\n" .'* **false**: disables the feature.'."\n" ."\n" .'> * If you set the Period parameter to Month, the auto-renewal cycle is one month.'."\n" .'> * If you set the Period parameter to Year, the auto-renewal cycle is one year.', 'type' => 'string', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'DeletionProtection', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable the release protection feature for the read-only instance. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false** (default)'."\n" ."\n" .'> You can enable the release protection feature for the read-only instance only when you set the **PayType** parameter to **Postpaid**.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false', ], ], [ 'name' => 'Port', 'in' => 'query', 'schema' => [ 'description' => 'The port that can be initialized when you create a read-only ApsaraDB RDS for MySQL instance.'."\n" ."\n" .'Valid values: 1000 to 65534.'."\n", 'type' => 'string', 'required' => false, 'example' => '3306', ], ], [ 'name' => 'BurstingEnabled', 'in' => 'query', 'schema' => [ 'description' => 'An invalid parameter. You do not need to specify this parameter.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'IsAnalyticReadOnlyIns', 'in' => 'query', 'schema' => [ 'type' => 'boolean', ], ], [ 'name' => 'AutoPay', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to automatically complete the payment. Valid values:'."\n" ."\n" .'1. **true**: automatically completes the payment. Make sure that your account balance is sufficient.'."\n" .'2. **false**: does not automatically complete the payment. An unpaid order is generated.'."\n" ."\n" .'> Default value: true. If your account balance is insufficient, you can set the AutoPay parameter to false to generate an unpaid order. Then, you can log on to the ApsaraDB RDS console to complete the payment.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'true', ], ], [ 'name' => 'AutoCreateProxy', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to automatically create database proxies. Valid values:'."\n" ."\n" .'* **true**: automatically creates database proxies. By default, general-purpose database proxies are created.'."\n" .'* **false**: does not automatically create database proxies.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false', ], ], [ 'name' => 'IoAccelerationEnabled', 'in' => 'query', 'schema' => [ 'description' => 'A reserved parameter.', 'type' => 'string', 'required' => false, 'example' => 'None', ], ], [ 'name' => 'AutoUseCoupon', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to use a coupon. Valid values:'."\n" ."\n" .'* **true**: uses a coupon.'."\n" .'* **false** (default): does not use a coupon.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'PromotionCode', 'in' => 'query', 'schema' => [ 'description' => 'The coupon code.'."\n", 'type' => 'string', 'required' => false, 'example' => '717446260784', ], ], [ 'name' => 'CustomExtraInfo', 'in' => 'query', 'schema' => [ 'type' => 'string', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'ConnectionString' => [ 'description' => 'The internal endpoint that is used to connect to the read-only instance.'."\n", 'type' => 'string', 'example' => 'rr-****.mysql.rds.aliyuncs.com', ], 'DBInstanceId' => [ 'description' => 'The ID of the read-only instance.'."\n", 'type' => 'string', 'example' => 'rr-uf6wjk5****', ], 'OrderId' => [ 'description' => 'The ID of the order.'."\n", 'type' => 'string', 'example' => '10078937****', ], 'Port' => [ 'description' => 'The internal port number that is used to connect to the read-only instance.'."\n", 'type' => 'string', 'example' => '3306', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidEngineVersion.Malformed', 'errorMessage' => 'The specified parameter EngineVersion is not valid.', ], [ 'errorCode' => 'InvalidNetworkTypeClassicWhenCloudStorage', 'errorMessage' => 'The Specified InstanceNetworkType value Classic is not valid when choose cloud storage type.', ], [ 'errorCode' => 'InvalidSecurityIPList.Malformed', 'errorMessage' => 'The specified parameter SecurityIPList is not valid.', ], [ 'errorCode' => 'InvalidSecurityIPList.Duplicate', 'errorMessage' => 'The Security IP address is not in the available range or occupied.', ], [ 'errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter dbInstanceId is not valid.', ], [ 'errorCode' => 'OperationDenied', 'errorMessage' => 'VPC IP is in use, please check.', ], [ 'errorCode' => 'InvalidZoneId.NotSupported', 'errorMessage' => 'The Specified vpc Zone not supported.', ], [ 'errorCode' => 'InvalidAvZone.NotSupport', 'errorMessage' => 'Specified availableArea multiZone does not support in RDS.', ], [ 'errorCode' => 'CDDC.AvailableHostsNotEnoughInZone', 'errorMessage' => 'Not enough available hosts are in the target zone.', ], [ 'errorCode' => 'InvalidReadEngineVersionPattern', 'errorMessage' => 'The engine versions of the primary instance and the read-only instance do not match.', ], [ 'errorCode' => 'InvalidDBInstanceClass.Offline', 'errorMessage' => 'The specified instance type is no longer provided. Please specify another instance type.', ], [ 'errorCode' => 'SYSTEM.CONCURRENT_OPERATE', 'errorMessage' => 'Concurrent operation is detected.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'InvalidDBInstanceName.Duplicate', 'errorMessage' => 'Specified DB instance name already exists in the Aliyun RDS.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidRequestId', 'errorMessage' => 'The request is copy, check your token.', ], [ 'errorCode' => 'InvalidParam.InstanceNetworkType', 'errorMessage' => 'Creation of classic network instances is not supported.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'InvalidVSwitchId.Format', 'errorMessage' => 'The specified vswitch Id format is incorrect.', ], [ 'errorCode' => 'InvalidParameterValue.NotStandard', 'errorMessage' => 'Invalid parameter format.', ], [ 'errorCode' => 'AtLeastThreeVSwitchAvailableIp', 'errorMessage' => 'The primary vswitch requires at least three available IP addresses.', ], [ 'errorCode' => 'AtLeastTwoVSwitchAvailableIp', 'errorMessage' => 'The primary vswitch requires at least two available IP addresses.', ], [ 'errorCode' => 'DuckDBOperationConflictBetweenPrimaryAndReadOnlyInstance', 'errorMessage' => 'Current instance is already attached to another duckdb instance, operation is conflict.', ], ], 403 => [ [ 'errorCode' => 'OperationDenied.PrimaryDBInstanceStatus', 'errorMessage' => 'The operation is not permitted due to status of primary instance.', ], [ 'errorCode' => 'InvalidReadStorageTypePattern', 'errorMessage' => 'The storage type of the primary instance and the read-only instance do not match.', ], [ 'errorCode' => 'IncorrectCharacterType', 'errorMessage' => 'Current DB instance character type does not support this operation.', ], [ 'errorCode' => 'InvalidMultiparamZoneInfoList', 'errorMessage' => 'Zoneinfo list is invaild.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], [ 'errorCode' => 'BasicCategoryNotSupport', 'errorMessage' => 'The Basic category is not supported.', ], ], [ [ 'errorCode' => 'IncorrectDBInstanceConnType', 'errorMessage' => 'Current DB instance conn type does not support this operation.', ], [ 'errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance does not exist or is not supported.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'CannotDecreaseEssdPerfLevel', 'errorMessage' => 'cannot decrease cloud essd performance level.', ], [ 'errorCode' => 'InvalidEssdStorageSize', 'errorMessage' => 'invalid cloud essd storage size.', ], [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"ConnectionString\\": \\"rr-****.mysql.rds.aliyuncs.com\\",\\n \\"DBInstanceId\\": \\"rr-uf6wjk5****\\",\\n \\"OrderId\\": \\"10078937****\\",\\n \\"Port\\": \\"3306\\",\\n \\"RequestId\\": \\"1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC\\"\\n}","errorExample":""},{"type":"xml","example":"\\n rr-uf6wjk5****\\n 1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC\\n 3306\\n rr-****.mysql.rds.aliyuncs.com\\n 10078937****\\n","errorExample":""}]', 'title' => 'CreateReadOnlyDBInstance', 'description' => '### Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" ."\n" .'### References'."\n" ."\n" .'> Before you call this operation, read the following documentation and make sure that you fully understand the prerequisites and impacts of this operation.'."\n" ."\n" .'* [Create a read-only ApsaraDB RDS for MySQL instance](~~56991~~)'."\n" .'* [Create a read-only ApsaraDB RDS for PostgreSQL instance](~~108959~~)'."\n" .'* [Create a read-only ApsaraDB RDS for SQL Server instance](~~99005~~)', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ModifyReadonlyInstanceDelayReplicationTime' => [ 'summary' => 'Modifies the latency at which a read-only ApsaraDB RDS for MySQL instance replicates data from its primary instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the read-only instance. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rr-bpxxxxx', ], ], [ 'name' => 'ReadSQLReplicationTime', 'in' => 'query', 'schema' => [ 'description' => 'The replication latency of the data replication. Unit: seconds.'."\n", 'type' => 'string', 'required' => true, 'example' => '100', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The resource group ID. You can call the DescribeDBInstanceAttribute to query the resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'DBInstanceId' => [ 'description' => 'The ID of the read-only instance.'."\n", 'type' => 'string', 'example' => 'rr-bpxxxxx', ], 'ReadSQLReplicationTime' => [ 'description' => 'The latency at which to replicate data from the primary instance to the read-only instance. Unit: seconds.'."\n", 'type' => 'string', 'example' => '100', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'BBB11B5A-7B37-493A-87E6-490BCB7BDF98', ], 'TaskId' => [ 'description' => 'The task ID.'."\n", 'type' => 'string', 'example' => '241535739', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OperationDenied.DBInstanceType', 'errorMessage' => 'The operation is not permitted due to type of instance.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'EngineNotSupported', 'errorMessage' => 'Engine specified cannot be supported the operation.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBInstanceId\\": \\"rr-bp****\\",\\n \\"ReadSQLReplicationTime\\": \\"100\\",\\n \\"RequestId\\": \\"BBB11B5A-7B37-493A-87E6-490BCB7BDF98\\",\\n \\"TaskId\\": \\"241535739\\"\\n}","errorExample":""},{"type":"xml","example":"\\n241535739\\nBBB11B5A-7B37-493A-87E6-490BCB7BDF98\\nrr-bpxxxxx\\n100\\n","errorExample":""}]', 'title' => 'ModifyReadonlyInstanceDelayReplicationTime', 'description' => '### Supported database engines'."\n" ."\n" .'RDS MySQL'."\n" ."\n" .'### References'."\n" ."\n" .'> : Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.'."\n" ."\n" .'[Set the data replication latency of a read-only ApsaraDB RDS for MySQL instance](~~96056~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeReadDBInstanceDelay' => [ 'summary' => 'Queries the latency of data replication between a primary instance and its read-only instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'default' => 'cn-hangzhou', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The primary instance ID. You can call the DescribeDBInstances operation to query the primary instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-bp*****', ], ], [ 'name' => 'ReadInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The read-only instance ID. You can call the DescribeDBInstances operation to query the read-only instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rr-bp*****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'DBInstanceId' => [ 'description' => 'The primary instance ID.'."\n", 'type' => 'string', 'example' => 'rm-bp*****', ], 'DelayTime' => [ 'description' => 'The latency of data replication. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'Items' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Items' => [ 'description' => 'The latency information.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'DBInstanceId' => [ 'description' => 'The primary instance ID.'."\n", 'type' => 'string', 'example' => 'rm-bp*****', ], 'ReadDBInstanceNames' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'ReadDBInstanceName' => [ 'description' => 'An array that consists of information about the read-only instance.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The read-only instance name.'."\n" ."\n" .'> This parameter is returned only when the primary instance runs MySQL.'."\n", 'type' => 'string', 'example' => 'rr-bp*****', ], ], ], ], 'ReadDelayTimes' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'ReadDelayTime' => [ 'description' => 'The latency of data replication.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The consumption latency.'."\n" ."\n" .'> This parameter is returned only when the primary instance runs MySQL.'."\n", 'type' => 'string', 'example' => '0', ], ], ], ], 'ReadonlyInstanceDelay' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'ReadonlyInstanceDelay' => [ 'description' => 'The information about the write-ahead log (WAL) latency.'."\n" ."\n" .'> This parameter is returned only when the primary instance runs PostgreSQL.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'FlushLag' => [ 'description' => 'The duration that is allowed for the latency in the persistence of WAL data. Unit: seconds.'."\n", 'type' => 'string', 'example' => '0', ], 'FlushLatency' => [ 'description' => 'The data size that is allowed for the latency in the persistence of WAL data. Unit: MB.'."\n", 'type' => 'string', 'example' => '0', ], 'ReadDBInstanceName' => [ 'description' => 'The read-only instance ID.'."\n", 'type' => 'string', 'example' => 'rr-bp*****', ], 'ReplayLag' => [ 'description' => 'The duration that is allowed for the latency in the playback of WAL data. Unit: seconds.'."\n", 'type' => 'string', 'example' => '0', ], 'ReplayLatency' => [ 'description' => 'The data size that is allowed for the latency in the playback of WAL data. Unit: MB.'."\n", 'type' => 'string', 'example' => '0', ], 'SendLatency' => [ 'description' => 'The data size that is allowed for the latency in the sending of WAL data. Unit: MB.'."\n", 'type' => 'string', 'example' => '0', ], 'WriteLag' => [ 'description' => 'The duration that is allowed for the latency in the write-back of WAL data. Unit: seconds.'."\n", 'type' => 'string', 'example' => '0', ], 'WriteLatency' => [ 'description' => 'The data size that is allowed for the latency in the write-back of WAL data. Unit: MB.'."\n", 'type' => 'string', 'example' => '0', ], ], ], ], ], ], ], ], ], ], ], 'ReadDBInstanceId' => [ 'description' => 'The read-only instance ID.'."\n", 'type' => 'string', 'example' => 'rr-bp*****', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'F1BDDEA8-452D-450B-AB10-CD5C5BAFC5DF', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidReadDBInstance.NotFound', 'errorMessage' => 'The specified read only database instance does not exist.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBInstanceId\\": \\"rm-bp****\\",\\n \\"DelayTime\\": 0,\\n \\"Items\\": {\\n \\"Items\\": [\\n {\\n \\"DBInstanceId\\": \\"rm-bp****\\",\\n \\"ReadDBInstanceNames\\": {\\n \\"ReadDBInstanceName\\": [\\n \\"\\\\\\"ReadDBInstanceName\\\\\\": [\\\\\\"rr-bp****\\\\\\"]\\"\\n ]\\n },\\n \\"ReadDelayTimes\\": {\\n \\"ReadDelayTime\\": [\\n \\"\\\\\\"ReadDelayTime\\\\\\": [\\\\\\"0\\\\\\"]\\"\\n ]\\n },\\n \\"ReadonlyInstanceDelay\\": {\\n \\"ReadonlyInstanceDelay\\": [\\n {\\n \\"FlushLag\\": \\"0\\",\\n \\"FlushLatency\\": \\"0\\",\\n \\"ReadDBInstanceName\\": \\"rr-bp****\\",\\n \\"ReplayLag\\": \\"0\\",\\n \\"ReplayLatency\\": \\"0\\",\\n \\"SendLatency\\": \\"0\\",\\n \\"WriteLag\\": \\"0\\",\\n \\"WriteLatency\\": \\"0\\"\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"ReadDBInstanceId\\": \\"rr-bp****\\",\\n \\"RequestId\\": \\"F1BDDEA8-452D-450B-AB10-CD5C5BAFC5DF\\"\\n}","errorExample":""},{"type":"xml","example":"\\n rm-bp*****\\n F1BDDEA8-452D-450B-AB10-CD5C5BAFC5DF\\n 0\\n rr-bp*****\\n \\n rm-bp*****\\n \\"ReadDelayTime\\": [\\"0\\"]\\n \\"ReadDBInstanceName\\": [\\"rr-bp*****\\"]\\n \\n","errorExample":""}]', 'title' => 'DescribeReadDBInstanceDelay', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'PrecheckDuckDBDependency' => [ 'summary' => 'Checks whether DuckDB-based analytical instances can be created for the specified RDS for PostgreSQL primary instance. If DuckDB-based analytical instances cannot be created, this operation returns the failure causes and provides solutions or recommended specification values.', 'path' => '', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The primary instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'pgm-2zegy5pdkg58****'."\n", ], ], [ 'name' => 'TargetMode', 'in' => 'query', 'schema' => [ 'type' => 'string', 'example' => 'readOnly', 'default' => 'readOnly', 'enum' => [ 'primary', 'readOnly', ], ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'FailedCheckItems' => [ 'description' => 'The check items that do not meet the requirements for creating DuckDB-based analytical instances.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'AllowAutoModify' => [ 'description' => 'Indicates whether the item can be changed with one click to meet the requirements.'."\n" ."\n" .'* **true**: Yes. You can call the [ModifyDBInstanceConfig](~~2623684~~) operation to change the item with one click.'."\n" .'* **false**: No.'."\n" ."\n" .'> If the major engine version of the primary does not meet the requirements, you must manually upgrade it.'."\n", 'type' => 'boolean', 'enumValueTitles' => [ 'true' => 'true', 'false' => 'false', ], 'example' => ' false', ], 'CurrentValue' => [ 'description' => 'The current value of the check item.'."\n", 'type' => 'string', 'example' => '15.0', ], 'Name' => [ 'description' => 'The name of the check item.'."\n", 'type' => 'string', 'example' => 'MajorVersion', ], 'RequiredValue' => [ 'description' => 'The value or value range that meets the requirements.'."\n", 'type' => 'string', 'example' => '17.0', ], 'Type' => [ 'description' => 'The check item. Valid values:'."\n" ."\n" .'* **Parameter**: The parameters of the primary instance.'."\n" .'* **MinorVersion**: The minor engine version of the primary instance.'."\n" .'* **MajorVersion**: The major engine version of the primary instance.'."\n", 'type' => 'string', 'enumValueTitles' => [ 'MajorVersion' => 'MajorVersion', 'Parameter' => 'Parameter', 'MinorVersion' => 'MinorVersion', ], 'example' => 'Parameter', ], ], 'description' => '', ], ], 'Result' => [ 'description' => 'Indicates whether the primary instance meet the requirements for creating DuckDB-based analytical instances. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'enumValueTitles' => [ 'true' => 'true', 'false' => 'false', ], 'example' => ' false', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', ], [ 'errorCode' => 'ReadonlyInstanceNotSupport', 'errorMessage' => 'The operation is not permitted due to type of the instance.', ], [ 'errorCode' => 'InvalidEngineVersion', 'errorMessage' => 'The specified EngineVersion is invalid.', ], [ 'errorCode' => 'MissingParameter.MinorVersionTag', 'errorMessage' => 'You must specify the parameter MinorVersionTag.', ], [ 'errorCode' => 'Workbench.InternalFailure', 'errorMessage' => 'ECS workbench returns an internal failure. Please check password expiration policy and / or other issues.', ], [ 'errorCode' => 'DuckDBOperationConflictBetweenPrimaryAndReadOnlyInstance', 'errorMessage' => 'Current instance is already attached to another duckdb instance, operation is conflict.', ], ], 403 => [ [ 'errorCode' => 'ReadOnlyInstanceNotSupport', 'errorMessage' => 'Read-only instance does not support this operation.', ], [ 'errorCode' => 'DBInstanceStatusNotActive', 'errorMessage' => 'The status of the current instance is not active.', ], [ 'errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'The database instance type does not support the operation.', ], [ 'errorCode' => 'GroupReplicationNotSupport.InvalidEngineVersion', 'errorMessage' => 'Group Replication requires the instance engine version to be 8.0.', ], [ 'errorCode' => 'IncorrectDBInstance', 'errorMessage' => 'The current DB instance does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', ], ], [ [ 'errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', ], [ 'errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance does not exist or is not supported.', ], ], 500 => [ [ 'errorCode' => 'InternalFailure', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"FailedCheckItems\\": [\\n {\\n \\"AllowAutoModify\\": true,\\n \\"CurrentValue\\": \\"15.0\\",\\n \\"Name\\": \\"MajorVersion\\",\\n \\"RequiredValue\\": \\"17.0\\",\\n \\"Type\\": \\"Parameter\\"\\n }\\n ],\\n \\"Result\\": true\\n}","type":"json"}]', 'title' => 'PrecheckDuckDBDependency', 'description' => '### [](#)Supported database engine'."\n" ."\n" .'RDS PostgreSQL'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'[DuckDB-based analytical instance](~~2977241~~)'."\n", ], 'CreateDBNodes' => [ 'summary' => 'Adds a node to an ApsaraDB RDS for MySQL or ApsaraDB RDS for PostgreSQL instance that runs RDS Cluster Edition. An RDS instance that runs RDS Cluster Edition is referred to as an RDS cluster.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests.'."\n" ."\n" .'The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCz****', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-2ze450g4ctg6t****', ], ], [ 'name' => 'DBNode', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The details of the node.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details of the node.'."\n", 'type' => 'object', 'properties' => [ 'classCode' => [ 'description' => 'The specification information of the node.'."\n", 'type' => 'string', 'required' => true, 'example' => 'mysql.n2.medium.xc', ], 'vswitchId' => [ 'description' => 'The vSwitch ID of the node.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vsw-bp1sxxsodv28ey5dl****', ], 'zoneId' => [ 'description' => 'The ID of the zone in which the node is deployed.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-zhangjiakou-a', ], ], 'required' => true, ], 'required' => true, 'maxItems' => 7, 'minItems' => 1, ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The resource group ID. You can call the DescribeDBInstanceAttribute operation to query the resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy*****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'DBInstanceId' => [ 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'rm-2ze450g4ctg6t****', ], 'NodeIds' => [ 'description' => 'The ID of the created node. The value is a string. Multiple values are separated by commas (`,`).'."\n", 'type' => 'string', 'example' => 'rn-abcd2*****', ], 'OrderId' => [ 'description' => 'The ID of the order.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2133400000*****', ], 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '7A41C147-C8D0-4DAE-A1A2-17EBCD60DFA1', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'DBNodeFormatFault', 'errorMessage' => 'The specified parameter DBNode is malformed', ], [ 'errorCode' => 'DBNodeParameterRequired', 'errorMessage' => 'The specified parameter DBNode is required.', ], [ 'errorCode' => 'DBNodeParameterTooManyItems', 'errorMessage' => 'The specified parameter DBNode has too many items.', ], [ 'errorCode' => 'DBNodeParameter.InvalidClassCode', 'errorMessage' => 'The ClassCode of the item of the specified parameter DBNode is inconsistent.', ], [ 'errorCode' => 'DBNodeParameter.InvalidValue', 'errorMessage' => 'The specific param DBNode is not valid.', ], [ 'errorCode' => 'DBNodeParameter.NotFound', 'errorMessage' => 'The specified parameter DBNode is not valid.', ], [ 'errorCode' => 'InvalidMultiTenant', 'errorMessage' => 'Multi tenants cannot exist in a same instance.', ], [ 'errorCode' => 'InvalidClassCode', 'errorMessage' => 'The specification code in the parameter is invalid.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'InvalidOrder.NotFound', 'errorMessage' => 'Specified order does not exist in RDS.', ], ], 403 => [ [ 'errorCode' => 'GroupReplicationNotSupport.InvalidEngineVersion', 'errorMessage' => 'Group Replication requires the instance engine version to be 8.0.', ], [ 'errorCode' => 'GroupReplicationNotSupport.InvalidNodeClassCode', 'errorMessage' => 'Group Replication requires the ClassCode of each node to be consistent.', ], [ 'errorCode' => 'GroupReplicationNotSupport.InvalidNodeNum', 'errorMessage' => 'Group Replication is not supported, the number of nodes must be an odd number greater than or equal to 3.', ], [ 'errorCode' => 'GroupReplicationNotSupport.InvalidXengine', 'errorMessage' => 'Group Replication is not supported because the instance has xengine tables.', ], [ 'errorCode' => 'GroupReplicationNotSupport.MemoryTooSmall', 'errorMessage' => 'Group Replication is not supported because the memory is too small.', ], [ 'errorCode' => 'OperationDenied.DBType', 'errorMessage' => 'The operation is not permitted due to type of the database.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBInstanceId\\": \\"rm-2ze450g4ctg6t****\\",\\n \\"NodeIds\\": \\"rn-abcd2****\\",\\n \\"OrderId\\": 0,\\n \\"RequestId\\": \\"7A41C147-C8D0-4DAE-A1A2-17EBCD60DFA1\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 7A41C147-C8D0-4DAE-A1A2-17EBCD60DFA1\\n rm-2ze450g4ctg6t****\\n","errorExample":""}]', 'title' => 'CreateDBNodes', 'description' => '### Supported database engines'."\n" ."\n" .'MySQL'."\n" ."\n" .'### References'."\n" ."\n" .'> Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.'."\n" ."\n" .'[Add a node to an ApsaraDB RDS for MySQL cluster](~~464129~~)'."\n", ], 'CreateDBInstanceEndpoint' => [ 'summary' => 'Creates an endpoint for an instance that runs RDS Cluster Edition.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests.'."\n" ."\n" .'The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => '6000170000591aed949d0f****', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-****', ], ], [ 'name' => 'VpcId', 'in' => 'query', 'schema' => [ 'title' => 'vpcID', 'description' => 'The VPC ID of the internal endpoint.'."\n", 'type' => 'string', 'required' => true, 'example' => 'vpc-xxxmmxjqqi****', ], ], [ 'name' => 'VSwitchId', 'in' => 'query', 'schema' => [ 'title' => 'vSwitchID', 'description' => 'The vSwitch ID of the internal endpoint.'."\n", 'type' => 'string', 'required' => true, 'example' => 'vsw-bp1kqp****', ], ], [ 'name' => 'PrivateIpAddress', 'in' => 'query', 'schema' => [ 'title' => '内网IP地址', 'description' => 'The IP address of the internal endpoint.'."\n", 'type' => 'string', 'required' => false, 'example' => '172.16.XX.XX', ], ], [ 'name' => 'ConnectionStringPrefix', 'in' => 'query', 'schema' => [ 'title' => '内网连接地址前缀', 'description' => 'The prefix of the internal endpoint.'."\n" ."\n" .'When you create any type of endpoint, an internal endpoint is automatically created for the endpoint. This parameter specifies the prefix of the internal endpoint.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-****-ro', ], ], [ 'name' => 'Port', 'in' => 'query', 'schema' => [ 'title' => '内网连接端口', 'description' => 'The port number of the internal endpoint. You can specify the port number for the internal endpoint.'."\n" ."\n" .'Valid values: 3000 to 5999.'."\n", 'type' => 'string', 'required' => true, 'example' => '3306', ], ], [ 'name' => 'DBInstanceEndpointType', 'in' => 'query', 'schema' => [ 'title' => 'Endpoint 类型, Primary, Readonly, Node', 'description' => 'The endpoint type. Valid values:'."\n" ."\n" .'* Primary: read/write endpoint of the instance'."\n" .'* Readonly: read-only endpoint of the instance'."\n", 'type' => 'string', 'required' => true, 'enumValueTitles' => [ 'Readonly' => 'Readonly', ], 'example' => 'Readonly', ], ], [ 'name' => 'DBInstanceEndpointDescription', 'in' => 'query', 'schema' => [ 'title' => 'Endpoint 用户自定义描述', 'description' => 'The user-defined description of the endpoint.'."\n", 'type' => 'string', 'required' => false, 'example' => 'for readonly business', ], ], [ 'name' => 'NodeItems', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The information about the endpoint.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the array object.'."\n", 'type' => 'object', 'properties' => [ 'DBInstanceId' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-****', ], 'NodeId' => [ 'description' => 'The node ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rn-xxxx-****', ], 'Weight' => [ 'description' => 'The weight of the node. Read requests are distributed based on the weight.'."\n" ."\n" .'Valid values: 0 to 100.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '50', ], ], 'required' => false, ], 'required' => true, ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The resource group ID. You can call the DescribeDBInstanceAttribute operation to obtain the ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResponse', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'ConnectionString' => [ 'description' => 'The internal endpoint.'."\n", 'type' => 'string', 'example' => 'rm-****.mysql.rds.aliyuncs.com', ], 'DBInstanceEndpointId' => [ 'description' => 'The endpoint ID of the instance.'."\n", 'type' => 'string', 'example' => 'ep-****', ], 'DBInstanceName' => [ 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'rm-****', ], ], ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'C8E88DED-533F-4B3C-9207-731FBF394CCA', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidSourceCategory', 'errorMessage' => 'specified source category is invalid.', ], [ 'errorCode' => 'InvalidDBInstanceConnType.Format', 'errorMessage' => 'Specified DB instance conn type is not valid.', ], [ 'errorCode' => 'EndpointNum.Error', 'errorMessage' => 'The number of endpoint is too many.', ], [ 'errorCode' => 'InvalidNodeItems.DuplicateNodeId', 'errorMessage' => 'Duplicate nodeId, please ensure all nodeIds are different.', ], [ 'errorCode' => 'InvalidNodeItems.RONode', 'errorMessage' => 'ReadOnly endpoint can not contain readonly instance node.', ], [ 'errorCode' => 'InvalidNodeItems.RONodeIdPrimary', 'errorMessage' => 'ReadOnly endpoint can not contain primary node.', ], [ 'errorCode' => 'InvalidNodeItems.JsonFormat', 'errorMessage' => 'NodeItems is not a json string.', ], [ 'errorCode' => 'InvalidNodeItems.DBInstanceId', 'errorMessage' => 'Specified dbInstanceId is invalid', ], [ 'errorCode' => 'InvalidNodeItems.NodeId', 'errorMessage' => 'Specified Node id is invalid', ], [ 'errorCode' => 'EndpointType.NotSupport', 'errorMessage' => 'Current db type is not support specified endpoint type.', ], [ 'errorCode' => 'OtherEndpoint.Exist', 'errorMessage' => 'Other endpoint already exist.', ], [ 'errorCode' => 'InvalidPort.Malformed', 'errorMessage' => 'Specified port is not valid.', ], [ 'errorCode' => 'APICallingFailed', 'errorMessage' => 'Api called failed, please check vpc vsw vip', ], [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The specified DB instance name does not exist.', ], [ 'errorCode' => 'InvalidNodeItems.BlackNodeItems', 'errorMessage' => 'NodeItems is blank.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', ], [ 'errorCode' => 'InvalidConnVPCId', 'errorMessage' => 'Specified conn vpc id is not valid.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.NotFound', 'errorMessage' => 'Specified connection string or net type is not found.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the Aliyun RDS.', ], [ 'errorCode' => 'InvalidWeight.Format', 'errorMessage' => 'The Specified Weight format is not valid.', ], [ 'errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'Specified instance does not exist or not support.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": {\\n \\"ConnectionString\\": \\"rm-****.mysql.rds.aliyuncs.com\\",\\n \\"DBInstanceEndpointId\\": \\"ep-****\\",\\n \\"DBInstanceName\\": \\"rm-****\\"\\n },\\n \\"RequestId\\": \\"C8E88DED-533F-4B3C-9207-731FBF394CCA\\"\\n}","errorExample":""},{"type":"xml","example":"\\n \\n rm-****\\n ep-****\\n rm-****.mysql.rds.aliyuncs.com\\n \\n C8E88DED-533F-4B3C-9207-731FBF394CCA\\n","errorExample":""}]', 'title' => 'CreateDBInstanceEndpoint', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'MySQL'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.'."\n" ."\n" .'[Create a read-only endpoint for a cluster](~~464132~~)'."\n", ], 'CreateDBInstanceEndpointAddress' => [ 'summary' => 'Creates a public endpoint for an instance that runs RDS Cluster Edition.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests.'."\n" ."\n" .'The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => '6000170000591aed949d0f****', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-****', ], ], [ 'name' => 'DBInstanceEndpointId', 'in' => 'query', 'schema' => [ 'title' => 'EndpointId', 'description' => 'The endpoint ID of the instance. You can call the DescribeDBInstanceEndpoints operation to query the endpoint ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ep-****', ], ], [ 'name' => 'ConnectionStringPrefix', 'in' => 'query', 'schema' => [ 'title' => '连接串前缀', 'description' => 'The prefix of the public endpoint.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-*****', ], ], [ 'name' => 'Port', 'in' => 'query', 'schema' => [ 'title' => '连接地址端口', 'description' => 'The port number of the public endpoint.'."\n", 'type' => 'string', 'required' => true, 'example' => '3306', ], ], [ 'name' => 'IpType', 'in' => 'query', 'schema' => [ 'title' => '连接类型, Public, Private', 'description' => 'The network type of the endpoint. Only Internet is supported. Set the value to **Public**.'."\n", 'type' => 'string', 'required' => true, 'enumValueTitles' => [ 'Public' => 'Public', ], 'example' => 'Public', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The resource group ID. You can call the DescribeDBInstanceAttribute operation to obtain the ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResponse', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'ConnectionString' => [ 'description' => 'The public endpoint.'."\n", 'type' => 'string', 'example' => 'rm-******.mysql.rds.aliyuncs.com', ], 'DBInstanceEndpointId' => [ 'description' => 'The endpoint ID of the instance.'."\n", 'type' => 'string', 'example' => 'ep-****', ], 'DBInstanceName' => [ 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'rm-****', ], ], ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '08A3B71B-FE08-4B03-974F-CC7EA6DB1828', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidSourceCategory', 'errorMessage' => 'specified source category is invalid.', ], [ 'errorCode' => 'InvalidDBInstanceConnType.Format', 'errorMessage' => 'Specified DB instance conn type is not valid.', ], [ 'errorCode' => 'IncorrectDBInstanceNetType', 'errorMessage' => 'Current DB instance net type does not support this operation.', ], [ 'errorCode' => 'EndpointType.NotSupport', 'errorMessage' => 'Current db type is not support specified endpoint type.', ], [ 'errorCode' => 'APICallingFailed', 'errorMessage' => 'Meta db calling failed.', ], [ 'errorCode' => 'EngineNotSupported', 'errorMessage' => 'The engine does not support the operation.', ], [ 'errorCode' => 'InvalidEngineVersion.NotSupport', 'errorMessage' => 'The specified parameter "EngineVersion" is not valid.', ], [ 'errorCode' => 'InvalidBizType.Format', 'errorMessage' => 'Specified biz type is not valid.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', ], [ 'errorCode' => 'NetTypeExists', 'errorMessage' => 'Specified net type already existed.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'Invalid DBInstanceId NotFound.', ], [ 'errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the Aliyun RDS.', ], [ 'errorCode' => 'Endpoint.NotFound', 'errorMessage' => 'Specified endpoint is not existed.', ], [ 'errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'Specified instance does not exist or not support.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": {\\n \\"ConnectionString\\": \\"rm-****.mysql.rds.aliyuncs.com\\",\\n \\"DBInstanceEndpointId\\": \\"ep-****\\",\\n \\"DBInstanceName\\": \\"rm-****\\"\\n },\\n \\"RequestId\\": \\"08A3B71B-FE08-4B03-974F-CC7EA6DB1828\\"\\n}","errorExample":""},{"type":"xml","example":"\\n \\n rm-****\\n ep-****\\n rm-******.mysql.rds.aliyuncs.com\\n \\n 08A3B71B-FE08-4B03-974F-CC7EA6DB1828\\n","errorExample":""}]', 'title' => 'CreateDBInstanceEndpointAddress', 'description' => '### [](#)Supported database engine'."\n" ."\n" .'MySQL'."\n" ."\n" .'### [](#)Precautions'."\n" ."\n" .'* You can create a public endpoint of an endpoint type only when no public endpoint is created for this endpoint type.'."\n" .'* The node weights and other configurations are the same as those of the internal endpoint of this endpoint type. Each type of endpoint can contain an internal endpoint and a public endpoint.'."\n", ], 'DeleteDBNodes' => [ 'summary' => 'Deletes a node from an instance that runs RDS Cluster Edition.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that it is unique among different requests.'."\n" ."\n" .'The token can only contain ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCz****', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-uf6wjk5****', ], ], [ 'name' => 'DBNodeId', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The node IDs.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The node ID.'."\n" ."\n" .'You can query the node ID by using the following methods:'."\n" ."\n" .'* Log on the ApsaraDB RDS console, go to the instance details page, and then view the ID of the node in the instance topology in the lower part of the instance details page.'."\n" .'* Call the DescribeDBInstanceAttribute operation to query the node ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rn-m8f****', ], 'required' => true, 'maxItems' => 7, 'minItems' => 1, ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the resource group. You can call the DescribeDBInstanceAttribute operation to obtain the ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'DBInstanceId' => [ 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5****', ], 'OrderId' => [ 'description' => 'The ID of the order.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '100780000000000', ], 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '8B993DA9-5272-5414-94E3-4CA8BA0146C2', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'DBNodeFormatFault', 'errorMessage' => 'The specified parameter DBNode is malformed', ], [ 'errorCode' => 'DBNodeIdParameterInvalid', 'errorMessage' => 'The specified parameter DBNodeId is malformed.', ], [ 'errorCode' => 'DBNodeIdParameterNotFound', 'errorMessage' => 'The specified parameter DBNodeId is required.', ], [ 'errorCode' => 'DBNodeParameter.TooFewItems', 'errorMessage' => 'The specified parameter DBNode has too few items.', ], [ 'errorCode' => 'DBNodeParameter.InvalidClassCode', 'errorMessage' => 'The ClassCode of the item of the specified parameter DBNode is inconsistent.', ], [ 'errorCode' => 'DBNodeIdParameter.NotExists', 'errorMessage' => 'The DBNodeId in the parameter does not exist.', ], [ 'errorCode' => 'DBNodeIdParameter.IncludePrimary', 'errorMessage' => 'The specified parameter DBNodeId include primary node.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'GroupReplicationNotSupport.InvalidEngineVersion', 'errorMessage' => 'Group Replication requires the instance engine version to be 8.0.', ], [ 'errorCode' => 'GroupReplicationNotSupport.InvalidNodeClassCode', 'errorMessage' => 'Group Replication requires the ClassCode of each node to be consistent.', ], [ 'errorCode' => 'GroupReplicationNotSupport.InvalidNodeNum', 'errorMessage' => 'Group Replication is not supported, the number of nodes must be an odd number greater than or equal to 3.', ], [ 'errorCode' => 'GroupReplicationNotSupport.InvalidXengine', 'errorMessage' => 'Group Replication is not supported because the instance has xengine tables.', ], [ 'errorCode' => 'GroupReplicationNotSupport.MemoryTooSmall', 'errorMessage' => 'Group Replication is not supported because the memory is too small.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], [ 'errorCode' => 'OperationDenied.DBType', 'errorMessage' => 'The operation is not permitted due to type of the database.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBInstanceId\\": \\"rm-uf6wjk5****\\",\\n \\"OrderId\\": 100780000000000,\\n \\"RequestId\\": \\"8B993DA9-5272-5414-94E3-4CA8BA0146C2\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 8B993DA9-5272-5414-94E3-4CA8BA0146C2\\n rm-uf6wjk5****\\n 100780000000000\\n","errorExample":""}]', 'title' => 'DeleteDBNodes', 'description' => '### [](#)Supported database engine'."\n" ."\n" .'MySQL'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> Before you call this operation, read the following topics and make sure that you fully understand the prerequisites and impacts of this operation.'."\n" ."\n" .'[Delete a node from an ApsaraDB RDS for MySQL cluster](~~464130~~)'."\n", ], 'DeleteDBInstanceEndpoint' => [ 'summary' => 'Deletes an endpoint for an instance that runs RDS Cluster Edition.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotency of requests. You can use the client to generate the value, but you must ensure that it is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => '0c593ea1-3bea-11e9-b96b-88****', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-****', ], ], [ 'name' => 'DBInstanceEndpointId', 'in' => 'query', 'schema' => [ 'title' => 'EndpointId', 'description' => 'The endpoint ID of the instance. You can call the DescribeDBInstanceEndpoints operation to query the endpoint ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ep-****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResponse', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'DBInstanceEndpointId' => [ 'description' => 'The endpoint ID of the instance.'."\n", 'type' => 'string', 'example' => 'ep-****', ], 'DBInstanceName' => [ 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'rm-****', ], ], ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '224DB9F7-3100-4899-AB9C-C938BCCB43E7', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidSourceCategory', 'errorMessage' => 'specified source category is invalid.', ], [ 'errorCode' => 'InvalidDBInstanceConnType.Format', 'errorMessage' => 'Specified DB instance conn type is not valid.', ], [ 'errorCode' => 'EndpointType.NotSupport', 'errorMessage' => 'Current db type is not support specified endpoint type.', ], [ 'errorCode' => 'APICallingFailed', 'errorMessage' => 'Meta db calling failed.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'Invalid DBInstanceId NotFound.', ], [ 'errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', ], [ 'errorCode' => 'Endpoint.NotFound', 'errorMessage' => 'Specified endpoint is not existed.', ], [ 'errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'Specified instance does not exist or not support.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": {\\n \\"DBInstanceEndpointId\\": \\"ep-****\\",\\n \\"DBInstanceName\\": \\"rm-****\\"\\n },\\n \\"RequestId\\": \\"224DB9F7-3100-4899-AB9C-C938BCCB43E7\\"\\n}","errorExample":""},{"type":"xml","example":"\\n \\n rm-****\\n ep-****\\n \\n 224DB9F7-3100-4899-AB9C-C938BCCB43E7\\n","errorExample":""}]', 'title' => 'DeleteDBInstanceEndpoint', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'MySQL'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.'."\n" ."\n" .'[Delete the read-only endpoint of an ApsaraDB RDS for MySQL cluster](~~464133~~)'."\n", ], 'DeleteDBInstanceEndpointAddress' => [ 'summary' => 'Releases the public endpoint of an instance that runs RDS Cluster Edition.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests.'."\n" ."\n" .'The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => '6000170000591aed949d0f****', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-****', ], ], [ 'name' => 'DBInstanceEndpointId', 'in' => 'formData', 'schema' => [ 'title' => 'EndpointId', 'description' => 'The endpoint ID of the instance. You can call the DescribeDBInstanceEndpoints operation to query the endpoint ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ep-****', ], ], [ 'name' => 'ConnectionString', 'in' => 'formData', 'schema' => [ 'title' => '连接串', 'description' => 'The public endpoint.'."\n", 'type' => 'string', 'required' => true, 'example' => 'new****.mysql.rds.aliyuncs.com', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResponse', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ 'DBInstanceEndpointId' => [ 'description' => 'The endpoint ID of the instance.'."\n", 'type' => 'string', 'example' => 'ep-****', ], 'DBInstanceName' => [ 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'rm-****', ], ], ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'F2911788-25E8-42E5-A3A3-1B38D263F01E', ], ], 'enumValueTitles' => [], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidSourceCategory', 'errorMessage' => 'specified source category is invalid.', ], [ 'errorCode' => 'InvalidDBInstanceConnType.Format', 'errorMessage' => 'Specified DB instance conn type is not valid.', ], [ 'errorCode' => 'InvalidNetType.Format', 'errorMessage' => 'Specified NetType is not valid.', ], [ 'errorCode' => 'InvalidConnectionString.Format', 'errorMessage' => 'Specified connection string is not valid.', ], [ 'errorCode' => 'APICallingFailed', 'errorMessage' => 'Meta db calling failed.', ], [ 'errorCode' => 'InvalidEngineVersion.NotSupport', 'errorMessage' => 'The specified parameter "EngineVersion" is not valid.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'Invalid DBInstanceId NotFound.', ], [ 'errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', ], [ 'errorCode' => 'Endpoint.NotFound', 'errorMessage' => 'Specified endpoint is not existed.', ], [ 'errorCode' => 'InvalidConnectionString.NotFound', 'errorMessage' => 'Specified connection string or net type is not found.', ], [ 'errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'Specified instance does not exist or not support.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": {\\n \\"DBInstanceEndpointId\\": \\"ep-****\\",\\n \\"DBInstanceName\\": \\"rm-****\\"\\n },\\n \\"RequestId\\": \\"F2911788-25E8-42E5-A3A3-1B38D263F01E\\"\\n}","errorExample":""},{"type":"xml","example":"\\n \\n rm-****\\n ep-****\\n \\n F2911788-25E8-42E5-A3A3-1B38D263F01E\\n","errorExample":""}]', 'title' => 'DeleteDBInstanceEndpointAddress', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'MySQL'."\n" ."\n" .'### [](#)Precautions'."\n" ."\n" .'You can delete only the public endpoint of each endpoint type from the instance. If you want to delete an internal endpoint of any endpoint type, you can directly delete the type of endpoint.'."\n", ], 'ModifyDBNode' => [ 'summary' => 'Changes the specifications, storage type, and storage capacity of an ApsaraDB RDS for MySQL instance that runs RDS Cluster Edition.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxx', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-bp1k8s41l2o52****', ], ], [ 'name' => 'DBInstanceStorageType', 'in' => 'query', 'schema' => [ 'description' => 'The storage type of the instance. Valid values:'."\n" ."\n" .'* **cloud_essd**: performance level 1 (PL1) enhanced SSD (ESSD)'."\n" .'* **cloud_essd2**: PL2 ESSD'."\n" .'* **cloud_essd3**: PL3 ESSD'."\n", 'type' => 'string', 'required' => false, 'example' => 'cloud_essd', ], ], [ 'name' => 'DBInstanceStorage', 'in' => 'query', 'schema' => [ 'description' => 'The new storage capacity of the instance. Unit: GB For more information, see [Instance types](~~26312~~).'."\n", 'type' => 'string', 'required' => false, 'example' => '20', ], ], [ 'name' => 'DBNode', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The information about the node.'."\n" ."\n" .'> This parameter is used for ApsaraDB RDS for MySQL instances that run RDS Cluster Edition.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details of the node.'."\n", 'type' => 'object', 'properties' => [ 'classCode' => [ 'description' => 'The specification information about the node.'."\n", 'type' => 'string', 'required' => false, 'example' => 'mysql.n2.medium.xc', ], 'nodeId' => [ 'description' => 'The node ID.'."\n", 'type' => 'string', 'required' => false, 'enumValueTitles' => [], 'example' => 'rn-6256r4a87xvv7he5p', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 7, 'minItems' => 1, ], ], [ 'name' => 'EffectiveTime', 'in' => 'query', 'schema' => [ 'description' => 'The time when you want the change to take effect. Valid values:'."\n" ."\n" .'* **Immediate** (default): The change immediately takes effect.'."\n" .'* **MaintainTime**: The effective time is within the maintenance window. For more information, see ModifyDBInstanceMaintainTime.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Immediate', 'default' => 'Immediate', ], ], [ 'name' => 'AutoPay', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to automatically complete the payment. Valid values:'."\n" ."\n" .'1. **true**: automatically completes the payment. Make sure that your account balance is sufficient.'."\n" .'2. **false**: does not automatically complete the payment. An unpaid order is generated.'."\n" ."\n" .'> The default value is true. If your account balance is insufficient, you can set the AutoPay parameter to false to generate an unpaid order. Then, you can log on to the ApsaraDB RDS console to pay for the order.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'DryRun', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to perform a dry run. Valid values: Valid values:'."\n" ."\n" .'* **true**: performs a dry run and does not perform the actual request. The system checks items such as the request parameters, request format, service limits, and available resources.'."\n" .'* **false** (default): performs a dry run and performs the actual request. If the request passes the dry run, the operation is performed.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'ProduceAsync', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to asynchronously perform the operation. Valid values:'."\n" ."\n" .'* **true** (default): sends only the order. The operation is asynchronously performed.'."\n" .'* **false**: sends the request. After the request passes the check, the operation is directly performed.'."\n" ."\n" .'> The default value is true, which indicates that the change operation is asynchronously performed. If you set this parameter to false, the change operation is simultaneously performed. This prolongs the response time of the operation.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'DBInstanceId' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5****', ], 'OrderId' => [ 'description' => 'The ID of the order.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '20793850608****', ], 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '5CD61041-35F7-10F7-BE94-33A48B221218', ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**: The request was successful.'."\n" .'* **false**: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'DBNodeFormatFault', 'errorMessage' => 'The specified parameter DBNode is malformed', ], [ 'errorCode' => 'DBNodeParameterRequired', 'errorMessage' => 'The specified parameter DBNode is required.', ], [ 'errorCode' => 'DBNodeIdParameter.NotExists', 'errorMessage' => 'The specified DBNodeId is not existed.', ], [ 'errorCode' => 'SecondaryClassCode.Unsupported', 'errorMessage' => 'At least one secondary node has the same classCode as the primary node.', ], [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'The current instance state does not support this operation.', ], [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The specified DB instance name does not exist.', ], [ 'errorCode' => 'InvalidNodeId', 'errorMessage' => 'Parameter node id is not valid.', ], [ 'errorCode' => 'SlaveClassCode.Unsupported', 'errorMessage' => 'Need at least one secondary\'s class_code same as primary\'s.', ], [ 'errorCode' => 'InvalidDBInstanceStorage', 'errorMessage' => 'The specified DBInstanceStorage is invalid.', ], [ 'errorCode' => 'UnsupportedOperationDirection.DiskUpgrade', 'errorMessage' => 'The specified operation is not allowed, class and storage can only modify to one direction, current class: DOWNGRADE.', ], [ 'errorCode' => 'UnsupportedOperationDirection.DiskDowngrade', 'errorMessage' => 'The specified operation is not allowed, class and storage can only modify to one direction, current class: UPGRADE', ], [ 'errorCode' => 'InvalidDBInstanceStorageType', 'errorMessage' => 'The specified DBInstanceStorageType is invalid.', ], [ 'errorCode' => 'InvalidMultiTenant', 'errorMessage' => 'Multi tenants cannot exist in a same instance.', ], [ 'errorCode' => 'DBNodeParameter.InvalidCombination', 'errorMessage' => 'DBNode class code combination is not valid.', ], [ 'errorCode' => 'InvalidClassCode', 'errorMessage' => 'The specification code in the parameter is invalid.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'InvalidSaleComponentFault', 'errorMessage' => 'The request not refer to the correct order sale component. please contact customer service.', ], [ 'errorCode' => 'OperationDenied.DBType', 'errorMessage' => 'The operation is not permitted due to type of the database.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance does not exist or is not supported.', ], [ 'errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'Current cluster resources are insufficient. Try again later.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DBInstanceId\\": \\"rm-uf6wjk5****\\",\\n \\"OrderId\\": 0,\\n \\"RequestId\\": \\"5CD61041-35F7-10F7-BE94-33A48B221218\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'ModifyDBNode', 'description' => '### [](#)Supported database engine'."\n" ."\n" .'* MySQL'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'[Change instance specifications](~~2627998~~)'."\n" ."\n" .'> Fees of an instance are changed if the call is successful. Before you call this operation, carefully read the related topics.'."\n", ], 'ModifyDBInstanceEndpoint' => [ 'summary' => 'Modifies the weight of an endpoint for an instance that runs RDS Cluster Edition.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests.'."\n" ."\n" .'The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => '6000170000591aed949d0f****', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-****', ], ], [ 'name' => 'DBInstanceEndpointId', 'in' => 'query', 'schema' => [ 'title' => 'EndpointId', 'description' => 'The endpoint ID of the instance. You can call the DescribeDBInstanceEndpoints operation to query the endpoint ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ep-****', ], ], [ 'name' => 'DBInstanceEndpointDescription', 'in' => 'query', 'schema' => [ 'title' => 'Endpoint 用户自定义描述', 'description' => 'The user-defined description of the endpoint.'."\n", 'type' => 'string', 'required' => false, 'example' => 'for readonly business', ], ], [ 'name' => 'NodeItems', 'in' => 'query', 'allowEmptyValue' => true, 'style' => 'json', 'schema' => [ 'description' => 'The information about the endpoint.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details of the node.'."\n", 'type' => 'object', 'properties' => [ 'DBInstanceId' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rm-****', ], 'NodeId' => [ 'description' => 'The node ID.'."\n" ."\n" .'You can query the node ID by using the following methods:'."\n" ."\n" .'* Log on the ApsaraDB RDS console, go to the instance details page, and then view the ID of the node in the instance topology in the lower part of the instance details page.'."\n" .'* Call the DescribeDBInstanceAttribute operation to query the node ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rn-xxxx-****', ], 'Weight' => [ 'description' => 'The weight of the node. Read requests are distributed based on the weight.'."\n" ."\n" .'Valid values: 0 to 100.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '50', ], ], 'required' => false, ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResponse', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ 'DBInstanceEndpointId' => [ 'description' => 'The endpoint ID of the instance.'."\n", 'type' => 'string', 'example' => 'ep-****', ], 'DBInstanceName' => [ 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'rm-****', ], ], ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'F2911788-25E8-42E5-A3A3-1B38D263F01E', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidSourceCategory', 'errorMessage' => 'specified source category is invalid.', ], [ 'errorCode' => 'InvalidDBInstanceConnType.Format', 'errorMessage' => 'Specified DB instance conn type is not valid.', ], [ 'errorCode' => 'APICallingFailed', 'errorMessage' => 'Meta db calling failed.', ], [ 'errorCode' => 'InvalidNodeItems.JsonFormat', 'errorMessage' => 'NodeItems is not a json string.', ], [ 'errorCode' => 'EmptyEndpointNodeConfig', 'errorMessage' => 'Specified endpoint has no nodes, add node to endpoint first.', ], [ 'errorCode' => 'InvalidNodeItems.RONodeIdPrimary', 'errorMessage' => 'ReadOnly endpoint can not contain primary node.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', ], [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'Invalid DBInstanceId NotFound.', ], [ 'errorCode' => 'Endpoint.NotFound', 'errorMessage' => 'Specified endpoint is not existed.', ], [ 'errorCode' => 'InvalidConnectionString.NotFound', 'errorMessage' => 'Specified connection string or net type is not found.', ], [ 'errorCode' => 'InvalidWeight.Format', 'errorMessage' => 'The Specified Weight format is not valid.', ], [ 'errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'Specified instance does not exist or not support.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": {\\n \\"DBInstanceEndpointId\\": \\"ep-****\\",\\n \\"DBInstanceName\\": \\"rm-****\\"\\n },\\n \\"RequestId\\": \\"F2911788-25E8-42E5-A3A3-1B38D263F01E\\"\\n}","errorExample":""},{"type":"xml","example":"\\n \\n rm-****\\n ep-****\\n \\n F2911788-25E8-42E5-A3A3-1B38D263F01E\\n","errorExample":""}]', 'title' => 'ModifyDBInstanceEndpoint', 'description' => '### [](#)Supported database engine'."\n" ."\n" .'MySQL'."\n", ], 'ModifyDBInstanceEndpointAddress' => [ 'summary' => 'Modifies the information about the endpoint of an instance that runs RDS Cluster Edition.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests.'."\n" ."\n" .'The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => '6000170000591aed949d0f****', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-****', ], ], [ 'name' => 'DBInstanceEndpointId', 'in' => 'query', 'schema' => [ 'title' => 'EndpointId', 'description' => 'The endpoint ID of the instance. You can call the DescribeDBInstanceEndpoints operation to query the endpoint ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ep-****', ], ], [ 'name' => 'ConnectionString', 'in' => 'query', 'schema' => [ 'title' => '修改的目标连接串', 'description' => 'The endpoint that you want to modify. The endpoint can be a public endpoint or an internal endpoint.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-uf6wjk5****.mysql.rds.aliyuncs.com', ], ], [ 'name' => 'VpcId', 'in' => 'query', 'schema' => [ 'title' => 'vpcID', 'description' => 'The VPC ID of the internal endpoint.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vpc-bp17xdic25d****', ], ], [ 'name' => 'VSwitchId', 'in' => 'query', 'schema' => [ 'title' => 'vSwitchID', 'description' => 'The vSwitch ID of the internal endpoint.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vsw-bp12u14ecz****', ], ], [ 'name' => 'PrivateIpAddress', 'in' => 'query', 'schema' => [ 'title' => '私网IP地址', 'description' => 'The IP address of the internal endpoint.'."\n", 'type' => 'string', 'required' => false, 'example' => '172.16.XX.XX', ], ], [ 'name' => 'ConnectionStringPrefix', 'in' => 'query', 'schema' => [ 'title' => '连接串前缀', 'description' => 'The prefix of the new endpoint. You can modify only the prefix of the endpoint that is specified by the ConnectionString parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rm-bp181qoj4s34m33****', ], ], [ 'name' => 'Port', 'in' => 'query', 'schema' => [ 'title' => '连接端口', 'description' => 'The port number of the new endpoint.'."\n", 'type' => 'string', 'required' => false, 'example' => '3306', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResponse', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'DBInstanceEndpointId' => [ 'description' => 'The endpoint ID of the instance.'."\n", 'type' => 'string', 'example' => 'ep-****', ], 'DBInstanceName' => [ 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'rm-****', ], ], ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '90496720-2319-42A8-87CD-FCE4DF95EBED', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidSourceCategory', 'errorMessage' => 'specified source category is invalid.', ], [ 'errorCode' => 'InvalidDBInstanceConnType.Format', 'errorMessage' => 'Specified DB instance conn type is not valid.', ], [ 'errorCode' => 'InvalidConnectionString.Format', 'errorMessage' => 'Specified connection string is not valid.', ], [ 'errorCode' => 'InvalidParamCombination', 'errorMessage' => 'VPCId,VSwitchId,PrivateIPAddress can not be modified with ConnectionStringPrefix,Port.', ], [ 'errorCode' => 'EmptyEndpointNodeConfig', 'errorMessage' => 'Specified endpoint has no nodes, add node to endpoint first.', ], [ 'errorCode' => 'APICallingFailed', 'errorMessage' => 'Api called failed, please check vpc vsw vip', ], [ 'errorCode' => 'InvalidEngineVersion.NotSupport', 'errorMessage' => 'The specified parameter "EngineVersion" is not valid.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', ], [ 'errorCode' => 'InvalidConnVPCId', 'errorMessage' => 'Specified conn vpc id is not valid.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'Invalid DBInstanceId NotFound.', ], [ 'errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', ], [ 'errorCode' => 'Endpoint.NotFound', 'errorMessage' => 'Specified endpoint is not existed.', ], [ 'errorCode' => 'InvalidConnectionString.NotFound', 'errorMessage' => 'Specified connection string or net type is not found.', ], [ 'errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'Specified instance does not exist or not support.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": {\\n \\"DBInstanceEndpointId\\": \\"ep-****\\",\\n \\"DBInstanceName\\": \\"rm-****\\"\\n },\\n \\"RequestId\\": \\"90496720-2319-42A8-87CD-FCE4DF95EBED\\"\\n}","errorExample":""},{"type":"xml","example":"\\n \\n rm-****\\n ep-****\\n \\n 90496720-2319-42A8-87CD-FCE4DF95EBED\\n","errorExample":""}]', 'title' => 'ModifyDBInstanceEndpointAddress', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'MySQL'."\n" ."\n" .'### [](#)Precautions'."\n" ."\n" .'* You can modify the following information about the endpoint of an instance: the public and internal endpoints, the public and internal ports, and the virtual private cloud (VPC), vSwitch, and IP address of the internal endpoint.'."\n" .'* The VPC and vSwitch must be modified at the same time. If you specify the VPC, vSwitch, and IP address of the internal endpoint, you do not need to specify the endpoint and port. If you specify the endpoint and port, you do not need to specify the VPC, vSwitch, and IP address of the internal endpoint.'."\n", ], 'DescribeDBInstanceEndpoints' => [ 'summary' => 'Queries the information about the endpoints of an instance that runs RDS Cluster Edition.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests.'."\n" ."\n" .'The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOC****', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-u****', ], ], [ 'name' => 'DBInstanceEndpointId', 'in' => 'query', 'schema' => [ 'description' => 'The endpoint ID of the instance.'."\n" ."\n" .'> If this parameter is not specified, the information about all endpoints is returned.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ep-****-ro', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResponse', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'DBInstanceEndpoints' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'DBInstanceEndpoint' => [ 'description' => 'The information of the endpoints of the instance.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details of the endpoint.'."\n", 'type' => 'object', 'properties' => [ 'AddressItems' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'AddressItem' => [ 'description' => 'The information about the endpoint.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The connection details.'."\n", 'type' => 'object', 'properties' => [ 'ConnectionString' => [ 'description' => 'The endpoints of the instance.'."\n", 'type' => 'string', 'example' => 'rm****.mysql.rds.aliyuncs.com', ], 'IpAddress' => [ 'description' => 'The IP address.'."\n", 'type' => 'string', 'example' => '10.71.XX.XX', ], 'IpType' => [ 'description' => 'The type of the IP address. Valid values:'."\n" ."\n" .'* **Public**: Internet'."\n" .'* **Private**: internal network'."\n", 'type' => 'string', 'example' => 'Private', ], 'Port' => [ 'description' => 'The port number of the endpoint.'."\n", 'type' => 'string', 'example' => '3306', ], 'VSwitchId' => [ 'description' => 'The vSwitch ID.'."\n", 'type' => 'string', 'example' => 'vsw-bp12u14ecz****', ], 'VpcId' => [ 'description' => 'The VPC ID.'."\n", 'type' => 'string', 'example' => 'vpc-bp17xdic25d****', ], ], ], ], ], ], 'EndpointDescription' => [ 'description' => 'The user-defined description of the endpoint.'."\n", 'type' => 'string', 'example' => 'for readonly business', ], 'EndpointId' => [ 'description' => 'The endpoint ID of the instance.'."\n", 'type' => 'string', 'example' => 'ep-****', ], 'EndpointType' => [ 'description' => 'The type of the endpoint. Valid values:'."\n" ."\n" .'* **Primary**: the read/write endpoint of the instance'."\n" .'* **Readonly**: the read-only endpoint of the instance'."\n", 'type' => 'string', 'example' => 'Readonly', ], 'NodeItems' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'NodeItem' => [ 'description' => 'The information about the node that is configured for the endpoint.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details of the endpoint.'."\n", 'type' => 'object', 'properties' => [ 'DBInstanceId' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-u****', ], 'NodeId' => [ 'description' => 'The node ID.'."\n", 'type' => 'string', 'example' => 'rn-****13p6tum4289h', ], 'Weight' => [ 'description' => 'The weight of the node. Read requests are distributed based on the weight.'."\n" ."\n" .'Valid values: 0 to 100.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '50', ], ], ], ], ], ], ], ], ], ], ], 'DBInstanceName' => [ 'description' => 'The name of the instance.'."\n", 'type' => 'string', 'example' => 'rm-u****', ], 'IpVersion' => [ 'description' => 'The version of the IP protocol. Valid values:'."\n" ."\n" .'* **ipv4**'."\n" .'* **ipv6**'."\n", 'type' => 'string', 'example' => 'ipv4', ], ], ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '777C4593-8053-427B-****105593277CAB', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'APICallingFailed', 'errorMessage' => 'Meta db calling failed.', ], [ 'errorCode' => 'InvalidSourceCategory', 'errorMessage' => 'specified source category is invalid.', ], [ 'errorCode' => 'InvalidDBInstanceConnType.Format', 'errorMessage' => 'Specified DB instance conn type is not valid.', ], [ 'errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', ], [ 'errorCode' => 'InvalidEngineVersion.NotSupport', 'errorMessage' => 'The specified parameter "EngineVersion" is not valid.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', ], [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', ], [ 'errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'Specified instance does not exist or not support.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": {\\n \\"DBInstanceEndpoints\\": {\\n \\"DBInstanceEndpoint\\": [\\n {\\n \\"AddressItems\\": {\\n \\"AddressItem\\": [\\n {\\n \\"ConnectionString\\": \\"rm****.mysql.rds.aliyuncs.com\\",\\n \\"IpAddress\\": \\"10.71.XX.XX\\",\\n \\"IpType\\": \\"Private\\",\\n \\"Port\\": \\"3306\\",\\n \\"VSwitchId\\": \\"vsw-bp12u14ecz****\\",\\n \\"VpcId\\": \\"vpc-bp17xdic25d****\\"\\n }\\n ]\\n },\\n \\"EndpointDescription\\": \\"for readonly business\\",\\n \\"EndpointId\\": \\"ep-****\\",\\n \\"EndpointType\\": \\"Readonly\\",\\n \\"NodeItems\\": {\\n \\"NodeItem\\": [\\n {\\n \\"DBInstanceId\\": \\"rm-u****\\",\\n \\"NodeId\\": \\"rn-****13p6tum4289h\\",\\n \\"Weight\\": 50\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"DBInstanceName\\": \\"rm-u****\\",\\n \\"IpVersion\\": \\"ipv4\\"\\n },\\n \\"RequestId\\": \\"777C4593-8053-427B-****105593277CAB\\"\\n}","errorExample":""},{"type":"xml","example":"\\n \\n rm-u****\\n ipv4\\n \\n ep-****\\n Readonly\\n for readonly business\\n \\n rn-****13p6tum4289h\\n rm-u****\\n 50\\n \\n \\n vpc-bp17xdic25d****\\n vsw-bp12u14ecz****\\n Private\\n 3306\\n rm****.mysql.rds.aliyuncs.com\\n 10.71.XX.XX\\n \\n \\n \\n 777C4593-8053-427B-****105593277CAB\\n","errorExample":""}]', 'title' => 'DescribeDBInstanceEndpoints', 'description' => '### [](#)Supported database engine'."\n" ."\n" .'MySQL'."\n", ], 'CreateDBProxyEndpointAddress' => [ 'summary' => 'Creates the endpoint that is used to connect to the dedicated proxy of an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-t4n3axxxxx', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-t4n3axxxxx', ], ], [ 'name' => 'DBProxyEndpointId', 'in' => 'query', 'schema' => [ 'description' => 'The proxy endpoint ID. You can call the DescribeDBProxyEndpoint operation to query the proxy endpoint ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ta9um4xxxxx', ], ], [ 'name' => 'ConnectionStringPrefix', 'in' => 'query', 'schema' => [ 'description' => 'The prefix of the proxy endpoint Enter a custom prefix.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test1234', ], ], [ 'name' => 'DBProxyNewConnectStringPort', 'in' => 'query', 'schema' => [ 'description' => 'The port number that is associated with the proxy endpoint.'."\n" ."\n" .'* If the instance runs MySQL, the default value is **3306**.'."\n" .'* If the instance runs PostgreSQL, the default value is **5432**.'."\n", 'type' => 'string', 'required' => false, 'example' => '3306', ], ], [ 'name' => 'DBProxyConnectStringNetType', 'in' => 'query', 'schema' => [ 'description' => 'The network type of the proxy endpoint. Valid values:'."\n" ."\n" .'* **Public**: Internet'."\n" .'* **VPC**: Virtual Private Cloud (VPC)'."\n" .'* **Classic**: classic network'."\n" ."\n" .'Default value: **Classic**'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Public', ], ], [ 'name' => 'VPCId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the VPC to which the proxy endpoint belongs. You can call the DescribeDBInstanceAttribute operation to query the information.'."\n" ."\n" .'> This parameter must be specified when **DBProxyConnectStringNetType** is set to **VPC**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vpc-bpxxxxxx', ], ], [ 'name' => 'VSwitchId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the vSwitch that is associated with the specified VPC. You can call the DescribeDBInstanceAttribute operation to query the vSwitch ID.'."\n" ."\n" .'> This parameter must be specified when **DBProxyConnectStringNetType** is set to **VPC**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vsw-bpxxxxxx', ], ], [ 'name' => 'DBProxyEngineType', 'in' => 'query', 'schema' => [ 'description' => 'A reserved parameter. You do not need to specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'normal', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy*****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'F2911788-25E8-42E5-A3A3-1B38D263F01E', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidPort.Malformed', 'errorMessage' => 'Specified port is not valid.', ], [ 'errorCode' => 'NetTypeExists', 'errorMessage' => 'Specified net type already existed.', ], [ 'errorCode' => 'IncorrectDBInstanceNetType', 'errorMessage' => 'Current DB instance net type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the Aliyun RDS.', ], [ 'errorCode' => 'InvalidConnVPCId', 'errorMessage' => 'Specified conn vpc id is not valid.', ], [ 'errorCode' => 'InvalidVpcInstanceId', 'errorMessage' => 'Specified vpc instance id is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceName', 'errorMessage' => 'Specified parameter DBInstanceName is not valid.', ], [ 'errorCode' => 'InvalidVpcIdOrVswitchId.NotSupported', 'errorMessage' => 'The specified vpcId or vSwitchId is not supported.', ], [ 'errorCode' => 'InvalidPrivateIpAddress.Mismatch', 'errorMessage' => 'Specified private IP address is not in the CIDR block of virtual switch.', ], [ 'errorCode' => 'InvalidVpcParameter', 'errorMessage' => 'Specified VPCId VSwitchId or IPAddress or TunnelId is not valid.', ], [ 'errorCode' => 'InvalidBizType.Format', 'errorMessage' => 'Specified biz type is not valid.', ], [ 'errorCode' => 'InvalidVSwitchId.NotFound', 'errorMessage' => 'Specified vSwitch is not found in specified VPC.', ], [ 'errorCode' => 'InvalidVSwitchId.Mismatch', 'errorMessage' => 'Specified instance and virtual switch are not in the same zone.', ], [ 'errorCode' => 'InvalidPrivateIpAddress.AlreadyUsed', 'errorMessage' => 'The specified IP is already used.', ], [ 'errorCode' => 'VswitchIpExhausted', 'errorMessage' => 'No available ip in the specified vswitch.', ], [ 'errorCode' => 'MaxscaleNotSupport', 'errorMessage' => 'Current custins can not support Maxscale.', ], [ 'errorCode' => 'InvalidConnectionString.Format', 'errorMessage' => 'Specified connection string is not valid.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'APICallingFailed', 'errorMessage' => 'Api calling failed.', ], [ 'errorCode' => 'InvalidVSwitchId.Format', 'errorMessage' => 'The specified vswitch Id format is incorrect.', ], [ 'errorCode' => 'InvalidDBProxyConnectStringNetType.NotSupported', 'errorMessage' => 'The Specified DBProxyConnectStringNetType is not supported.', ], ], 403 => [ [ 'errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstanceEngine', 'errorMessage' => 'Current DB Instance engine does not support this operation.', ], [ 'errorCode' => 'IncorrectKindCode', 'errorMessage' => 'Current custins kindCode does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstanceConnType', 'errorMessage' => 'Current DB instance conn type does not support this operation.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'Endpoint.NotFound', 'errorMessage' => 'Specified endpoint is not found.', ], [ 'errorCode' => 'Maxscale.NotFound', 'errorMessage' => 'The related maxscale instance is not found.', ], [ 'errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'Invalid DBInstanceId NotFound.', ], [ 'errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'Specified instance does not exist or not support.', ], [ 'errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'Current cluster resources are insufficient. Try again later.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F2911788-25E8-42E5-A3A3-1B38D263F01E\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\nF2911788-25E8-42E5-A3A3-1B38D263F01E\\r\\n","errorExample":""}]', 'title' => 'CreateDBProxyEndpointAddress', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.'."\n" ."\n" .'* [Configure the dedicated proxy endpoint of an ApsaraDB RDS for MySQL instance](~~184921~~)'."\n" .'* [Configure the dedicated proxy endpoint of an ApsaraDB RDS for PostgreSQL instance](~~418274~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DeleteDBProxyEndpointAddress' => [ 'summary' => 'Deletes the endpoint that is used to connect to the dedicated proxy of an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-t4n3a****', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-t4n3a****', ], ], [ 'name' => 'DBProxyEndpointId', 'in' => 'query', 'schema' => [ 'description' => 'The proxy endpoint ID. You can call the DescribeDBProxyEndpoint operation to query the proxy endpoint ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ta9um4****', ], ], [ 'name' => 'DBProxyConnectStringNetType', 'in' => 'query', 'schema' => [ 'description' => 'The network type of the proxy endpoint. Valid values:'."\n" ."\n" .'* **Public**: Internet'."\n" .'* **VPC**: virtual private cloud (VPC)'."\n" .'* **Classic**: classic network'."\n" ."\n" .'If the instance runs MySQL, the default value of this parameter is **Classic**.'."\n" ."\n" .'> If the instance runs PostgreSQL, you must set this parameter to **Public** or **VPC**.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Public', ], ], [ 'name' => 'DBProxyEngineType', 'in' => 'query', 'schema' => [ 'description' => 'A reserved parameter. You do not need to specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'normal', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '343356C6-64B2-4245-ADEB-C9BD165EDD11', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidVpcInstanceId', 'errorMessage' => 'Specified vpc instance id is not valid.', ], [ 'errorCode' => 'IncorrectDBInstanceNetType', 'errorMessage' => 'Current DB instance net type does not support this operation.', ], [ 'errorCode' => 'AtLeastOneNetTypeExists', 'errorMessage' => 'The current database instance network type does not support the operation', ], [ 'errorCode' => 'InvalidEndPoint.Format', 'errorMessage' => 'The specified EndPoint is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceName', 'errorMessage' => 'Specified parameter DBInstanceName is not valid.', ], [ 'errorCode' => 'MaxscaleNotSupport', 'errorMessage' => 'Current custins can not support Maxscale.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', ], [ 'errorCode' => 'IncorrectKindCode', 'errorMessage' => 'The current KindCode of the custins does not support the operation.', ], [ 'errorCode' => 'IncorrectDBInstanceEngine', 'errorMessage' => 'Current DB Instance engine does not support this operation.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'Endpoint.NotFound', 'errorMessage' => 'Specified endpoint is not found.', ], [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', ], [ 'errorCode' => 'Maxscale.NotFound', 'errorMessage' => 'The related maxscale instance is not found.', ], [ 'errorCode' => 'InvalidDBInstanceNetType.NotFound', 'errorMessage' => 'Specified DB instance net type is not found.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"343356C6-64B2-4245-ADEB-C9BD165EDD11\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n343356C6-64B2-4245-ADEB-C9BD165EDD11\\r\\n","errorExample":""}]', 'title' => 'DeleteDBProxyEndpointAddress', 'description' => '### Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" ."\n" .'### References'."\n" ."\n" .'> Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.'."\n" ."\n" .'* [Configure the dedicated proxy endpoint of an ApsaraDB RDS for MySQL instance](~~184921~~)'."\n" .'* [Configure the dedicated proxy endpoint for an ApsaraDB RDS for PostgreSQL instance](~~418274~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ModifyDBProxy' => [ 'summary' => 'Enables or modifies the database proxy feature for an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5xxxxxxx', ], ], [ 'name' => 'ConfigDBProxyService', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable or disable the database proxy feature. Valid values:'."\n" ."\n" .'* **Startup**: enables the feature.'."\n" .'* **Shutdown**: disables the feature.'."\n" .'* **Modify**: modifies the configuration of the feature.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Startup', ], ], [ 'name' => 'DBProxyInstanceNum', 'in' => 'query', 'schema' => [ 'description' => 'The number of proxy instances that are enabled. Valid values: **1** to **16**. Default value: **1**.'."\n" ."\n" .'> The capability of the database proxy to process requests increases with the number of proxy instances that are enabled. You can monitor the load on the instance and specify an appropriate number of proxy instances based on the load monitoring data.'."\n", 'type' => 'string', 'required' => false, 'example' => '1', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'InstanceNetworkType', 'in' => 'query', 'schema' => [ 'description' => 'The network type of the instance. Only the VPC network type is supported. Set the value to **VPC**.'."\n" ."\n" .'> If you enable the database proxy feature for the instance, you must specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'VPC', ], ], [ 'name' => 'VPCId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the virtual private cloud (VPC) to which the instance belongs. You can call the DescribeDBInstanceAttribute operation to query the ID.'."\n" ."\n" .'> If you enable the database proxy feature for the instance, you must specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vpc-xxxxxxxxxxxx', ], ], [ 'name' => 'VSwitchId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the vSwitch to which the instance belongs. You can call the DescribeDBInstanceAttribute operation to query the ID.'."\n" ."\n" .'> If you enable the database proxy feature for the instance, you must specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vsw-xxxxxxxxxxxx', ], ], [ 'name' => 'DBProxyEngineType', 'in' => 'query', 'schema' => [ 'description' => 'A deprecated parameter. You do not need to specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'normal', ], ], [ 'name' => 'DBProxyInstanceType', 'in' => 'query', 'schema' => [ 'description' => 'The database proxy type. Valid values:'."\n" ."\n" .'* **common**: general-purpose database proxy'."\n" .'* **exclusive** (default): dedicated database proxy'."\n", 'type' => 'string', 'required' => false, 'example' => 'common', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5xxxxxxx', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy*****', ], ], [ 'name' => 'PersistentConnectionStatus', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable persistent connections. Valid values:'."\n" ."\n" .'* **Enabled**'."\n" .'* **Disabled**'."\n" ."\n" .'> '."\n" ."\n" .'* This parameter is available only for instances that run MySQL.'."\n" ."\n" .'* If you want to modify persistent connections, you must set the **ConfigDBProxyService** parameter to **Modify**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Enabled', ], ], [ 'name' => 'DBProxyNodes', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The proxy nodes.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details of the proxy node.'."\n", 'type' => 'object', 'properties' => [ 'cpuCores' => [ 'description' => 'The number of CPU cores of the node. Valid values: **1** to **16**.'."\n" ."\n" .'> This parameter is required when you configure the **DBProxyNodes** parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => '1', ], 'nodeCounts' => [ 'description' => 'The number of proxy nodes in the zone. Valid values: **1** and **2**.'."\n" ."\n" .'> This parameter is required when you configure the **DBProxyNodes** parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => '2', ], 'zoneId' => [ 'description' => 'The ID of the zone in which the node resides.'."\n" ."\n" .'> This parameter is required when you configure the **DBProxyNodes** parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hagnzhou-c', ], ], 'required' => false, ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'FC452BB1-EED8-4278-95C7-0324B3710DF1', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'MaxscaleAlreadyExist', 'errorMessage' => 'The Maxscale is already existed.', ], [ 'errorCode' => 'MaxscaleNotSupport', 'errorMessage' => 'Maxscale not supported', ], [ 'errorCode' => 'NetWork.NotFound', 'errorMessage' => 'NetWork.NotFound', ], [ 'errorCode' => 'InvalidVpcParameter', 'errorMessage' => 'Either VPC ID or vSwitch ID is incorrect. Please check again.', ], [ 'errorCode' => 'MaxscaleInternalError', 'errorMessage' => 'Database proxy status is CLASS_CHANGING.', ], [ 'errorCode' => 'InvalidDBInstanceName', 'errorMessage' => 'Specified parameter DBInstanceName is not valid.', ], [ 'errorCode' => 'InvalidOptimizationCategory.Format', 'errorMessage' => 'Specified optimization category is not valid.', ], [ 'errorCode' => 'MinorVersionNotSupport', 'errorMessage' => 'The current database minor version does not support the operation.', ], [ 'errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'Specified parameter is not valid', ], [ 'errorCode' => 'InvalidTunnelId', 'errorMessage' => 'Specified conn tunnel is not valid.', ], [ 'errorCode' => 'InvalidRegion.Format', 'errorMessage' => 'Specified Region is not valid.', ], [ 'errorCode' => 'InvalidDBProxyNodes.General', 'errorMessage' => 'general-purpose proxy does not support more than 2 nodes.', ], [ 'errorCode' => 'InvalidDBProxyNodes.ZoneIdAndNodeCounts', 'errorMessage' => 'The number of node count and zone count is mismatch.', ], [ 'errorCode' => 'InvalidDBProxyNodes.ZoneId', 'errorMessage' => 'The number of zone is request 1 or 2.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'InvalidDBProxyNodes.ZoneIdNotUnique', 'errorMessage' => 'ZoneIds is not unique.', ], [ 'errorCode' => 'MaxscaleServiceLinkedRole.NotFound', 'errorMessage' => 'Service linked role \'AliyunServiceRoleForRDSProxyOnEcs\' not found.', ], [ 'errorCode' => 'MappingInstanceLevel.NotFound', 'errorMessage' => 'Can not find the mapping instance level.', ], ], 403 => [ [ 'errorCode' => 'InvalidConnVPCId', 'errorMessage' => 'Specified conn vpc id is not valid.', ], [ 'errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'The database instance type does not support the operation.', ], [ 'errorCode' => 'IncorrectDBInstanceEngine', 'errorMessage' => 'Current DB Instance engine does not support this operation.', ], [ 'errorCode' => 'IncorrectKindCode', 'errorMessage' => 'Current custins kindCode does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'MaxscaleCreating', 'errorMessage' => 'The relative maxscale instance is being created or deleted.', ], [ 'errorCode' => 'Maxscale.NotFound', 'errorMessage' => 'The relative maxscale instance is not found.', ], [ 'errorCode' => 'InvalidVSwitchId.NotFound', 'errorMessage' => 'The specified VSwitch is invalid.', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'The parameter is invalid.', ], [ 'errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The target availability zone does not have sufficient resources.', ], [ 'errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance does not exist or is not supported.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FC452BB1-EED8-4278-95C7-0324B3710DF1\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n FC452BB1-EED8-4278-95C7-0324B3710DF1\\r\\n","errorExample":""}]', 'title' => 'ModifyDBProxy', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" ."\n" .'> Starting October 17, 2023, ApsaraDB RDS for MySQL instances that run RDS Cluster Edition offer one free-of-charge dedicated database proxy for each unit in phases. For more information, see [\\[Special offers/Price changes\\] One dedicated proxy is provided free of charge for ApsaraDB RDS for MySQL instances on RDS Cluster Edition](~~2555466~~).'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> Before you call this operation, read the following topics and make sure that you fully understand the prerequisites and impacts of this operation.'."\n" ."\n" .'* [Enable the database proxy feature of ApsaraDB RDS for MySQL](~~197456~~)'."\n" .'* [Enable the database proxy feature of ApsaraDB RDS for PostgreSQL](~~418272~~)', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'UpgradeDBProxyInstanceKernelVersion' => [ 'summary' => 'Upgrades the database proxy version of an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5****', ], ], [ 'name' => 'UpgradeTime', 'in' => 'query', 'schema' => [ 'description' => 'The time when you want to upgrade the database proxy version of the instance. Valid values:'."\n" ."\n" .'* **MaintainTime** (default): performs the upgrade during the maintenance window that you specified. For more information, see [Modify the maintenance window](~~610402~~).'."\n" .'* **Immediate**: performs the upgrade immediately.'."\n" .'* **SpecifyTime**: performs the upgrade at a specified point in time.'."\n" ."\n" .'> * **If the instance runs MySQL, you can set this parameter to **MaintainTime**, **Immediate**, or SpecifyTime**.'."\n" .'> * If the instance runs PostgreSQL, you can set this parameter to **MaintainTime** or **Immediate**.', 'type' => 'string', 'required' => false, 'example' => 'MaintainTime', ], ], [ 'name' => 'SwitchTime', 'in' => 'query', 'schema' => [ 'description' => 'The specific point in time when you want to perform the upgrade. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time must be in UTC.'."\n" ."\n" .'> If you set **UpgradeTime** to **SpecifyTime**, you must specify SwitchTime.'."\n", 'type' => 'string', 'required' => false, 'example' => '2019-07-10T13:15:12Z', ], ], [ 'name' => 'TargetMinorVersion', 'in' => 'query', 'schema' => [ 'type' => 'string', ], ], [ 'name' => 'DBProxyEngineType', 'in' => 'query', 'schema' => [ 'description' => 'A reserved parameter. You do not need to specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'normal', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'DBInstanceName' => [ 'description' => 'The ID of the database proxy of the instance.'."\n", 'type' => 'string', 'example' => 'bu9***', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '44537EC8-DFA2-4745-B579-E733FF2C5B9A', ], 'TaskId' => [ 'description' => 'The task ID.'."\n", 'type' => 'string', 'example' => '33436****', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidDBInstanceName', 'errorMessage' => 'Specified parameter DBInstanceName is not valid.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'The proxy instance has not been activated.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'AllocateResourceFailed', 'errorMessage' => 'Failed to allocate resources. Please check the zone and the host you selected.', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'The parameter is invalid.', ], [ 'errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The target availability zone does not have sufficient resources.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBInstanceName\\": \\"bu9****\\",\\n \\"RequestId\\": \\"44537EC8-DFA2-4745-B579-E733FF2C5B9A\\",\\n \\"TaskId\\": \\"334362871\\"\\n}","errorExample":""},{"type":"xml","example":"\\n bu9***\\n 44537EC8-DFA2-4745-B579-E733FF2C5B9A\\n 334362871\\n","errorExample":""}]', 'title' => 'UpgradeDBProxyInstanceKernelVersion', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.'."\n" ."\n" .'* [Upgrade the database proxy version of an ApsaraDB RDS for MySQL instance](~~197465~~)'."\n" .'* [Upgrade the database proxy version of an ApsaraDB RDS for PostgreSQL instance](~~418469~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ModifyDBProxyInstance' => [ 'summary' => 'Changes the configuration of a database proxy for an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-t4n3a****', ], ], [ 'name' => 'DBProxyInstanceType', 'in' => 'query', 'schema' => [ 'description' => 'The database proxy type. Valid values:'."\n" ."\n" .'* **common**: general-purpose database proxy'."\n" .'* **exclusive** (default): dedicated database proxy'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'DedicatedProxy', ], ], [ 'name' => 'DBProxyInstanceNum', 'in' => 'query', 'schema' => [ 'description' => 'The number of database proxies. If you set this parameter to 0, the database proxy feature is disabled for the instance. Valid values: **1** to **16**.'."\n" ."\n" .'> The capability of the database proxy feature to process requests increases with the number of database proxies that are enabled. You can monitor the load on the instance and specify an appropriate number of database proxies based on the load monitoring data.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2', ], ], [ 'name' => 'EffectiveTime', 'in' => 'query', 'schema' => [ 'description' => 'The effective time. Valid values:'."\n" ."\n" .'* **Immediate**: The effective time is immediate.'."\n" .'* **MaintainTime**: The effective time is within the maintenance window. For more information, see ModifyDBInstanceMaintainTime.'."\n" .'* **SpecificTime**: The effective time is a specified point in time.'."\n" ."\n" .'Default value: **MaintainTime**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'MaintainTime', ], ], [ 'name' => 'EffectiveSpecificTime', 'in' => 'query', 'schema' => [ 'description' => 'The point in time that you want to specify. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time must be in UTC.'."\n" ."\n" .'> If the **EffectiveTime** parameter is set to **SpecificTime**, you must specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => '2019-07-10T13:15:12Z', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-t4n3a****', ], ], [ 'name' => 'DBProxyEngineType', 'in' => 'query', 'schema' => [ 'description' => 'A deprecated parameter. You do not need to specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'normal', ], ], [ 'name' => 'VSwitchIds', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the vSwitch in the destination zone. You can call the [DescribeVSwitches](~~610431~~) operation to query existing vSwitches.'."\n" ."\n" .'> Only database proxies for ApsaraDB RDS for MySQL instances that use cloud disks can be migrated to different zones.'."\n", 'type' => 'string', 'required' => false, 'example' => ' vsw-uf6adz52c2p****', ], ], [ 'name' => 'DBProxyNodes', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'List of proxy nodes.'."\n" ."\n" .'> This parameter must be passed when the current proxy instance is deployed in multiple availability zones.', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'cpuCores' => [ 'description' => 'The number of cpu cores for the node, valid values: **1** to **16**.'."\n" .'>This parameter is required when selecting **DBProxyNodes**.', 'type' => 'string', 'required' => false, 'example' => '1', ], 'nodeCounts' => [ 'description' => 'The number of proxy nodes in the availability zone, valid values: **1** to **16**.'."\n" .'>This parameter is required when selecting **DBProxyNodes**.', 'type' => 'string', 'required' => false, 'example' => '2', ], 'zoneId' => [ 'description' => 'The id of the availability zone where the node is located.'."\n" .'>This parameter is required when selecting **DBProxyNodes**.', 'type' => 'string', 'required' => false, 'example' => 'cn-hagnzhou-c', ], ], 'required' => false, ], 'required' => false, ], ], [ 'name' => 'MigrateAZ', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The list of available zones for migration agents.'."\n" ."\n" .'> Currently, only RDS MySQL cloud disk version agent instance migration is supported.', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'dbProxyEndpointId' => [ 'description' => 'The proxy connection address ID. You can obtain it through the DescribeDBProxyEndpoint interface.'."\n" ."\n" .'> This parameter is required when MigrateAZ is selected.', 'type' => 'string', 'required' => false, 'example' => ' yhw429********', ], 'destVSwitchId' => [ 'description' => 'The target VSwitchId corresponding to the proxy instance migration.'."\n" ."\n" .'> This parameter is required when MigrateAZ is selected.', 'type' => 'string', 'required' => false, 'example' => 'vsw-sw0qq49d1m****', ], 'destVpcId' => [ 'description' => 'The target vpc id corresponding to the proxy instance migration.', 'type' => 'string', 'required' => false, 'example' => 'vpc-2vcicu73rdylp****', ], ], 'required' => false, ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '65C55572-530E-4A53-BE03-1D08CAF0F046', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidDBInstanceName', 'errorMessage' => 'Specified parameter DBInstanceName is not valid.', ], [ 'errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'Specified parameter is not valid', ], [ 'errorCode' => 'InvalidAvZone.Format', 'errorMessage' => 'Specified AvZone is not valid.', ], [ 'errorCode' => 'ErrorMxsServiceInsNum.Error', 'errorMessage' => 'The Maxscale serviceIns num must be 1.', ], [ 'errorCode' => 'TaskExists', 'errorMessage' => 'Specified task have existed.', ], [ 'errorCode' => 'InvalidVSwitchIds', 'errorMessage' => 'Specified vSwitchId is invalid.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'APICallingFailed', 'errorMessage' => 'Api calling failed.', ], [ 'errorCode' => 'InvalidDBProxyNodes.AzProximity', 'errorMessage' => 'current proxy is open az proximity and target proxy not support az proximity.', ], [ 'errorCode' => 'InvalidDBProxyNodes.General', 'errorMessage' => 'general-purpose proxy does not support more than 2 nodes.', ], [ 'errorCode' => 'InvalidTargetAvailabilityZone', 'errorMessage' => 'All endpoint vswitchId must be in the target availability zone.', ], [ 'errorCode' => 'InvalidDBProxyNodes.Node', 'errorMessage' => 'must set DBProxyNodes params with more than 2 proxy nodes.', ], [ 'errorCode' => 'InvalidDBProxyNodes.ZoneIdAndNodeCounts', 'errorMessage' => 'The number of node count and zone count is mismatch.', ], [ 'errorCode' => 'InvalidDBProxyNodes.ZoneId', 'errorMessage' => 'The number of zone is request 1 or 2.', ], [ 'errorCode' => 'InvalidMigrateAZInfo', 'errorMessage' => 'Invalid MigrateAZ params.', ], [ 'errorCode' => 'InvalidDBProxyNodes.ZoneIdNotUnique', 'errorMessage' => 'ZoneIds is not unique.', ], [ 'errorCode' => 'InvalidVSwitchId.Format', 'errorMessage' => 'The specified vswitch Id format is incorrect.', ], [ 'errorCode' => 'InvalidEndPoint.Format', 'errorMessage' => 'The specified EndPoint is not valid.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'MappingInstanceLevel.NotFound', 'errorMessage' => 'Can not find the mapping instance level.', ], ], 403 => [ [ 'errorCode' => 'DBInstanceStatusNotActive', 'errorMessage' => 'Current DB instance status should be active.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'The specified class code does not support the endpoint number. Please check the shard number and the current endpoint number.', ], [ 'errorCode' => 'NotHaveProxy', 'errorMessage' => 'The current instance does not have a proxy.', ], [ 'errorCode' => 'MaxscaleMinorVersionNotSupport', 'errorMessage' => 'The Maxscale version used by the instance is too low, please upgrade the Maxscale version first.', ], [ 'errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance engine and type does not support operations.', ], [ 'errorCode' => 'IncorrectDBInstanceEngine', 'errorMessage' => 'Current DB Instance engine does not support this operation.', ], [ 'errorCode' => 'IncorrectKindCode', 'errorMessage' => 'Current custins kindCode does not support this operation.', ], [ 'errorCode' => 'IncorrectDBType', 'errorMessage' => 'The current DB type does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectDBInstance', 'errorMessage' => 'The current DB instance does not support this operation.', ], [ 'errorCode' => 'MaxscaleInstanceNotSupport', 'errorMessage' => 'Instances with maxscale instance do not support this operation.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], ], [ [ 'errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', ], [ 'errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'Specified DB instance class is not found.', ], [ 'errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The target availability zone does not have sufficient resources.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"65C55572-530E-4A53-BE03-1D08CAF0F046\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 65C55572-530E-4A53-BE03-1D08CAF0F046\\r\\n","errorExample":""}]', 'title' => 'ModifyDBProxyInstance', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" ."\n" .'> Starting October 17, 2023, ApsaraDB RDS for MySQL instances that run RDS Cluster Edition offer one free-of-charge dedicated database proxy for each unit in phases. For more information, see [\\[Special offers/Price changes\\] One dedicated proxy is provided free of charge for ApsaraDB RDS for MySQL instances on RDS Cluster Edition](~~2555466~~).'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ModifyDBProxyEndpoint' => [ 'summary' => 'Modifies the connection settings for a database proxy endpoint.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-bp145737x5bi6****', ], ], [ 'name' => 'DBProxyEndpointId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the proxy endpoint. You can call the DescribeDBProxyEndpoint operation to query the proxy endpoint ID.'."\n" ."\n" .'> * If the instance runs MySQL and you set **DbEndpointOperator** to **Delete** or **Modify**, you must specify DBProxyEndpointId.'."\n" .'> * If the instance runs PostgreSQL and you set **DbEndpointOperator** to **Delete**, **Modify**, or **Create**, you must specify DBProxyEndpointId.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'gos787jog2wk0y****', ], ], [ 'name' => 'ConfigDBProxyFeatures', 'in' => 'query', 'schema' => [ 'description' => 'The capabilities that you want to enable for the proxy endpoint. If you specify more than one capability, separate the capabilities with semicolons (;). Format: `Capability 1:Status;Capability 2:Status;...`. Do not add a semicolon (;) at the end of the value.'."\n" ."\n" .'Valid capability values:'."\n" ."\n" .'* **ReadWriteSpliting**: read/write splitting'."\n" .'* **ConnectionPersist**: connection pooling'."\n" .'* **TransactionReadSqlRouteOptimizeStatus**: transaction splitting'."\n" .'* **AZProximityAccess**: nearest access'."\n" .'* **CausalConsistRead**: read consistency'."\n" ."\n" .'Valid status values:'."\n" ."\n" .'* **1**: enabled'."\n" .'* **0**: disabled'."\n" ."\n" .'> '."\n" ."\n" .'* If the instance runs PostgreSQL, you can enable only read/write splitting, which is specified by **ReadWriteSpliting**.'."\n" ."\n" .'* Nearest access is supported only by dedicated database proxies for RDS instances that run MySQL.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ReadWriteSpliting:1;ConnectionPersist:0', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'ReadOnlyInstanceMaxDelayTime', 'in' => 'query', 'schema' => [ 'description' => 'The maximum latency threshold that is allowed for read/write splitting. If the latency on a read-only instance exceeds the threshold that you specified, the system no longer forwards read requests to the read-only instance. If you do not specify this parameter, the original value of this parameter is retained. Valid values: **0** to **3600**.'."\n" ."\n" .'> '."\n" ."\n" .'* You must specify this parameter only when read/write splitting is enabled.'."\n" ."\n" .'* If the database proxy endpoint has the read and write attributes, the default value of this parameter is **30** and read/write splitting is supported. If the database proxy endpoint has the read-only attribute, the default value of this parameter is **-1** and read/write splitting is not supported. Unit: seconds.'."\n", 'type' => 'string', 'required' => false, 'example' => '30', ], ], [ 'name' => 'CausalConsistReadTimeout', 'in' => 'query', 'schema' => [ 'description' => 'The consistency read timeout period. Unit: milliseconds. Default value: **10** Unit: milliseconds. Valid values: **0 to 60000**'."\n", 'type' => 'string', 'required' => false, 'example' => '10', ], ], [ 'name' => 'ReadOnlyInstanceDistributionType', 'in' => 'query', 'schema' => [ 'description' => 'The policy that is used to allocate read weights. Valid values:'."\n" ."\n" .'* **Standard** (default): The system automatically assigns read weights to the primary and read-only instances based on the specifications of these instances.'."\n" .'* **Custom**: You must manually allocate read weights to the primary and read-only instances.'."\n" ."\n" .'> You must specify this parameter when read/write splitting is enabled. For more information about the permission allocation policy, see [Modify the latency threshold and read weights of ApsaraDB RDS for MySQL instances](~~96076~~) and [Enable and configure the database proxy feature for an ApsaraDB RDS for PostgreSQL instance](~~418272~~).'."\n", 'type' => 'string', 'required' => false, 'example' => 'Standard', ], ], [ 'name' => 'ReadOnlyInstanceWeight', 'in' => 'query', 'schema' => [ 'description' => 'The read weights of the instance and its read-only instances. A read weight must be a multiple of 100 and cannot exceed 10000. Formats:'."\n" ."\n" .'* Standard instance: `{"ID of the primary instance":"Weight","ID of the read-only instance":"Weight"...}`'."\n" ."\n" .' Example: `{"rm-uf6wjk5****":"500","rr-tfhfgk5xxx":"200"...}`'."\n" ."\n" .'* Instance on RDS Cluster Edition: `{"ID of the read-only instance":"Weight","DBClusterNode":{"ID of the primary node":"Weight","ID of the secondary node":"Weight","ID of the secondary node":"Weight"...}}`'."\n" ."\n" .' Example: `{"rr-tfhfgk5****":"200","DBClusterNode":{"rn-2z****":"0","rn-2z****":"400","rn-2z****":"400"...}}`'."\n" ."\n" .' > **DBClusterNode** is required if the instance runs RDS Cluster Edition. The DBClusterNode parameter includes information about **IDs** and **weights** of the primary and secondary nodes..', 'type' => 'string', 'required' => false, 'example' => '{"rm-uf6wjk5xxxx":"500","rr-tfhfgk5xxx":"200"...}', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-bp145737x5bi6****', ], ], [ 'name' => 'DbEndpointOperator', 'in' => 'query', 'schema' => [ 'description' => 'The type of operation that you want to perform. Valid values:'."\n" ."\n" .'* **Modify**: Modify a proxy terminal. This is the default value.'."\n" .'* **Create**: Create a proxy terminal.'."\n" .'* **Delete**: Delete a proxy terminal.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Modify', ], ], [ 'name' => 'DbEndpointAliases', 'in' => 'query', 'schema' => [ 'description' => 'The description of the proxy terminal.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test-proxy', ], ], [ 'name' => 'DbEndpointType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the proxy terminal. This is a reserved parameter. You do not need to specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'RWSplit', ], ], [ 'name' => 'DbEndpointReadWriteMode', 'in' => 'query', 'schema' => [ 'description' => 'The read and write attributes of the proxy terminal. Valid values:'."\n" ."\n" .'* **ReadWrite**: The proxy terminal connects to the primary instance and can receive both read and write requests.'."\n" .'* **ReadOnly**: The proxy terminal does not connect to the primary instance and can receive only read requests. This is the default value.'."\n" ."\n" .'> * If you set **DbEndpointOperator** to **Create**, you must also specify DbEndpointReadWriteMode.'."\n" .'> * If the instance runs MySQL and you change the value of this parameter from **ReadWrite** to **ReadOnly**, the transaction splitting feature is disabled.', 'type' => 'string', 'required' => false, 'example' => 'ReadWrite', ], ], [ 'name' => 'DBProxyEngineType', 'in' => 'query', 'schema' => [ 'description' => 'A deprecated parameter. You do not need to specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'normal', ], ], [ 'name' => 'VSwitchId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the vSwitch in the zone in which the proxy endpoint is specified. The default value is the ID of the vSwitch that corresponds to the default terminal of the database proxy. You can call the DescribeVSwitches operation to query existing vSwitches.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vsw-uf6adz52c2p****', ], ], [ 'name' => 'EffectiveTime', 'in' => 'query', 'schema' => [ 'description' => 'The effective time. Valid values:'."\n" ."\n" .'* **Immediate**: The effective time is immediate.'."\n" .'* **MaintainTime**: The effective time is within the maintenance window. For more information, see ModifyDBInstanceMaintainTime.'."\n" .'* **SpecificTime**: The effective time is a specified point in time.'."\n" ."\n" .'Default value: **MaintainTime**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'MaintainTime', ], ], [ 'name' => 'EffectiveSpecificTime', 'in' => 'query', 'schema' => [ 'description' => 'The point in time that you want to specify. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time must be in UTC.'."\n" ."\n" .'> If **EffectiveTime** is set to **SpecificTime**, you must specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => '2023-05-06T07:08:09Z', ], ], [ 'name' => 'DbEndpointMinSlaveCount', 'in' => 'query', 'schema' => [ 'description' => 'The minimum number of reserved instances.'."\n", 'type' => 'string', 'required' => false, 'enumValueTitles' => [], 'example' => '2', ], ], [ 'name' => 'VpcId', 'in' => 'query', 'schema' => [ 'description' => 'The VPC ID of the zone in which the proxy endpoint is specified. The default value is the VPC ID that corresponds to the default terminal of the database proxy. You can call the DescribeDBInstanceAttribute operation to query the default VPC of an instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vpc-2zeusejj******', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '6B50D92C-1960-4D4F-A290-AFADD6B1A5C8', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidVpcInstanceId', 'errorMessage' => 'The specified VPC instance ID is invalid.', ], [ 'errorCode' => 'InvalidEndPoint.Format', 'errorMessage' => 'The specified EndPoint is not valid.', ], [ 'errorCode' => 'InvalidEndpointType.Format', 'errorMessage' => 'The specified EndpointType is invalid.', ], [ 'errorCode' => 'IncorrectDBInstanceNetType', 'errorMessage' => 'The current database instance network type does not support the operation.', ], [ 'errorCode' => 'EndpointNum.Error', 'errorMessage' => 'The number of endpoint is invalid.', ], [ 'errorCode' => 'EndpointTypeOperation.NotSupport', 'errorMessage' => 'The endpoint type does not support the operation.', ], [ 'errorCode' => 'InvalidDBInstanceName', 'errorMessage' => 'Specified parameter DBInstanceName is not valid.', ], [ 'errorCode' => 'ClusterEndpoint.StatusNotValid', 'errorMessage' => 'The cluster endpoint status is invalid.', ], [ 'errorCode' => 'MaxscaleNotSupport', 'errorMessage' => 'Current custins can not support Maxscale.', ], [ 'errorCode' => 'InvalidAvZone.Format', 'errorMessage' => 'Specified AvZone is not valid.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'APICallingFailed', 'errorMessage' => 'Api calling failed.', ], [ 'errorCode' => 'InvalidVSwitchId.Format', 'errorMessage' => 'The specified vswitch Id format is incorrect.', ], ], 403 => [ [ 'errorCode' => 'MaxScaleLevel.NotSupport', 'errorMessage' => 'The current maxscale ins_num does not support this operation.', ], [ 'errorCode' => 'ReadDBInstance.NotFound', 'errorMessage' => 'The current database instance does not contain any read only instance.', ], [ 'errorCode' => 'IncorrectKindCode', 'errorMessage' => 'The current KindCode of the custins does not support the operation.', ], [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'The current database instance state does not support the operation.', ], [ 'errorCode' => 'IncorrectDBInstanceEngine', 'errorMessage' => 'Current DB Instance engine does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'EndpointConfig.Invalid', 'errorMessage' => 'Please check the endpoint config parameter.', ], [ 'errorCode' => 'Readins.NotFound', 'errorMessage' => 'The current instance does not contain any read only instance. The operation is not supported.', ], [ 'errorCode' => 'Endpoint.NotFound', 'errorMessage' => 'Specified endpoint is not found.', ], [ 'errorCode' => 'EndpointType.NotFound', 'errorMessage' => 'The specified endpoint type is not found.', ], [ 'errorCode' => 'InvalidReadDBInstance.NotFound', 'errorMessage' => 'The specified read only database instance does not exist.', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'The specified Weight is invalid.', ], [ 'errorCode' => 'Maxscale.NotFound', 'errorMessage' => 'The related maxscale instance is not found.', ], [ 'errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6B50D92C-1960-4D4F-A290-AFADD6B1A5C8\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 6B50D92C-1960-4D4F-A290-AFADD6B1A5C8\\r\\n","errorExample":""}]', 'title' => 'ModifyDBProxyEndpoint', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* RDS MySQL'."\n" .'* RDS PostgreSQL'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> Before you call this operation, read the following topics and make sure that you fully understand the prerequisites and impacts of this operation.'."\n" ."\n" .'* [Configure the connection settings for a database proxy endpoint for an ApsaraDB RDS for MySQL instance](~~2621331~~)'."\n" .'* [Configure the connection settings for a database proxy endpoint for an ApsaraDB RDS for PostgreSQL instance](~~418273~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ModifyDBProxyEndpointAddress' => [ 'summary' => 'Modifies the database proxy endpoint of an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-t4n3a****', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-t4n3a****', ], ], [ 'name' => 'DBProxyEndpointId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the database proxy endpoint. You can call the DescribeDBProxyEndpoint operation to query the ID of the database proxy endpoint.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ta9um4****', ], ], [ 'name' => 'DBProxyNewConnectString', 'in' => 'query', 'schema' => [ 'description' => 'The prefix of the new database proxy endpoint. A custom value is supported.'."\n" ."\n" .'> You must specify at least one of the **DBProxyNewConnectString** and **DBProxyNewConnectStringPort** parameters.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test123456', ], ], [ 'name' => 'DBProxyNewConnectStringPort', 'in' => 'query', 'schema' => [ 'description' => 'The port number that is associated with the database proxy endpoint. A custom value is supported.'."\n" ."\n" .'> You must specify at least one of the **DBProxyNewConnectString** and **DBProxyNewConnectStringPort** parameters.'."\n", 'type' => 'string', 'required' => false, 'example' => '3307', ], ], [ 'name' => 'DBProxyConnectStringNetType', 'in' => 'query', 'schema' => [ 'description' => 'The network type of the database proxy endpoint. Valid values:'."\n" ."\n" .'* **Public**'."\n" .'* **VPC** (default)'."\n" ."\n" .'> If the RDS instance runs MySQL, this parameter is required.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Public', ], ], [ 'name' => 'DBProxyEngineType', 'in' => 'query', 'schema' => [ 'description' => 'A deprecated parameter. You do not need to specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'normal', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '50F6C32B-DD73-4DA1-ADA2-0EAF2B0FCD8A', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidConnectionString.Format', 'errorMessage' => 'Specified connection string is not valid.', ], [ 'errorCode' => 'InvalidPort.Malformed', 'errorMessage' => 'Specified port is not valid.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the Aliyun RDS.', ], [ 'errorCode' => 'InvalidConnectionStringOrPort.Duplicate', 'errorMessage' => 'Specified connection string or port want to be modified is the same with current net type.', ], [ 'errorCode' => 'InvalidDBInstanceName', 'errorMessage' => 'Specified parameter DBInstanceName is not valid.', ], [ 'errorCode' => 'OtherEndpoint.Exist', 'errorMessage' => 'Other endpoint already exist.', ], [ 'errorCode' => 'MaxscaleNotSupport', 'errorMessage' => 'Current custins can not support Maxscale.', ], [ 'errorCode' => 'ParameterLeastAssociate', 'errorMessage' => 'Must input at least one optional parameter', ], [ 'errorCode' => 'InvalidDBProxyConnectStringNetType.NotSupported', 'errorMessage' => 'The Specified DBProxyConnectStringNetType is not supported.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'ParameterLeastAssociate', 'errorMessage' => 'Must input at least one optional parameter.', ], [ 'errorCode' => 'NetTypeChangeTimesExceeded', 'errorMessage' => 'Exceeding the daily net type change times of the DB instance.', ], [ 'errorCode' => 'IncorrectDBInstanceEngine', 'errorMessage' => 'Current DB Instance engine does not support this operation.', ], [ 'errorCode' => 'IncorrectKindCode', 'errorMessage' => 'Current custins kindCode does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidConnectionString.NotFound', 'errorMessage' => 'Specified connection string or net type is not found.', ], [ 'errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is insufficient capacity available for the requested instance.', ], [ 'errorCode' => 'Endpoint.NotFound', 'errorMessage' => 'Specified endpoint is not found.', ], [ 'errorCode' => 'Maxscale.NotFound', 'errorMessage' => 'The related maxscale instance is not found.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the Aliyun RDS.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"50F6C32B-DD73-4DA1-ADA2-0EAF2B0FCD8A\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n50F6C32B-DD73-4DA1-ADA2-0EAF2B0FCD8A\\r\\n","errorExample":""}]', 'title' => 'ModifyDBProxyEndpointAddress', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> Before you call this operation, read the following topics and make sure that you fully understand the prerequisites and impacts of this operation.'."\n" ."\n" .'* [Configure the database proxy endpoint of an ApsaraDB RDS for MySQL instance](~~184921~~)'."\n" .'* [Configure the database proxy endpoint of an ApsaraDB RDS for PostgreSQL instance](~~418274~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ModifyDbProxyInstanceSsl' => [ 'summary' => 'Configures SSL encryption for an dedicated proxy endpoint of an ApsaraDB RDS for MySQL instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'DbInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-t4n3axxxxx', ], ], [ 'name' => 'DbInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-t4n3axxxxx', ], ], [ 'name' => 'DbProxyEndpointId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the proxy endpoint. You can call the DescribeDBProxyEndpoint operation to query the ID of the proxy endpoint.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ta9um4xxxxx', ], ], [ 'name' => 'DbProxyConnectString', 'in' => 'query', 'schema' => [ 'description' => 'The dedicated proxy endpoint of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test123456.rwlb.rds.aliyuncs.com', ], ], [ 'name' => 'DbProxySslEnabled', 'in' => 'query', 'schema' => [ 'description' => 'The SSL configuration setting that you want to apply on the instance. Valid values:'."\n" ."\n" .'* 0: disables SSL encryption.'."\n" .'* 1: enables SSL encryption or modifies the endpoint that requires SSL encryption.'."\n" .'* 2: updates the validity period of the SSL certificate.'."\n" ."\n" .'> This setting causes your instance to restart. Proceed with caution.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1', ], ], [ 'name' => 'DBProxyEngineType', 'in' => 'query', 'schema' => [ 'description' => 'A reserved parameter. You do not need to specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'normal', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'BF46A62B-3717-4397-9338-36BB95C898B3', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'MinorVersionNotSupport', 'errorMessage' => 'The current database minor version does not support the operation.', ], [ 'errorCode' => 'InvalidDbProxyStatus', 'errorMessage' => 'The proxy status of the database is abnormal.', ], [ 'errorCode' => 'InvalidDBInstanceName', 'errorMessage' => 'Specified parameter DBInstanceName is not valid.', ], [ 'errorCode' => 'MaxscaleNotSupport', 'errorMessage' => 'Current custins can not support Maxscale.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'MaxscaleDisabledSSLError', 'errorMessage' => 'Target connectString is not enabled SSL.', ], ], 403 => [ [ 'errorCode' => 'RDSCategoryNotSupport', 'errorMessage' => 'The specified instance category does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstanceEngine', 'errorMessage' => 'Current DB Instance engine does not support this operation.', ], [ 'errorCode' => 'IncorrectKindCode', 'errorMessage' => 'Current custins kindCode does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance engine and type does not support operations.', ], [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', ], [ 'errorCode' => 'ConnectionStringLengthExceeded', 'errorMessage' => 'Connection String is too long.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'Endpoint.NotFound', 'errorMessage' => 'The specified endpoint is not found.', ], [ 'errorCode' => 'EnabledSSLNotSupport', 'errorMessage' => 'The backend service does not support SSL.', ], [ 'errorCode' => 'InvalidDbProxyConnectionString.NotFound', 'errorMessage' => 'The specified database proxy connection string is not found.', ], [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', ], [ 'errorCode' => 'EndpointType.NotFound', 'errorMessage' => 'The specified endpoint type is not found.', ], [ 'errorCode' => 'EndpointConfig.Invalid', 'errorMessage' => 'Please check the endpoint config parameter.', ], [ 'errorCode' => 'InvalidMaxscaleConnectionString.NotFound', 'errorMessage' => 'The specified database proxy connection string is not found.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], [ 'errorCode' => 'InvalidMaxscaleConnectString.NotFound', 'errorMessage' => 'Specified MaxscaleConnectionString is not found or not belong to this endpoint.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BF46A62B-3717-4397-9338-36BB95C898B3\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\nBF46A62B-3717-4397-9338-36BB95C898B3\\r\\n","errorExample":""}]', 'title' => 'ModifyDbProxyInstanceSsl', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'RDS MySQL'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> : Before you call this operation, read the following documentation and make sure that you fully understand the prerequisites and impacts of this operation:'."\n" ."\n" .'[Configure SSL encryption for a proxy endpoint](~~188164~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeDBProxy' => [ 'summary' => 'Queries the settings of the database proxy feature for an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-bp1ja4f56s7us****', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-bp1ja4f56s7us****', ], ], [ 'name' => 'DBProxyEngineType', 'in' => 'query', 'schema' => [ 'description' => 'A deprecated parameter. You do not need to specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'normal', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy*****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'DBProxyInstanceMinorVersions' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'DBProxyInstanceMinorVersions' => [ 'type' => 'array', 'items' => [ 'type' => 'string', ], ], ], ], 'DBProxyConnectStringItems' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'DBProxyConnectStringItems' => [ 'description' => 'An array consisting of the information about the database proxy endpoint that is created for the instance.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The proxy endpoint that is created for the instance.'."\n", 'type' => 'object', 'properties' => [ 'DBProxyConnectString' => [ 'description' => 'The database proxy endpoint.'."\n", 'type' => 'string', 'example' => 'gos787jog2wk0ye1****-rw4rm.rwlb.rds.aliyuncs.com', ], 'DBProxyConnectStringNetType' => [ 'description' => 'The network type of the database proxy endpoint. A database proxy endpoint is formerly referred to as a proxy terminal. Valid values:'."\n" ."\n" .'* OuterString: Internet'."\n" .'* InnerString: internal network'."\n", 'type' => 'string', 'enumValueTitles' => [], 'example' => 'InnerString', ], 'DBProxyConnectStringNetWorkType' => [ 'description' => 'The network type of the database proxy. Valid values:'."\n" ."\n" .'* 0: Internet'."\n" .'* 1: classic network'."\n" .'* 2: virtual private cloud (VPC)'."\n", 'type' => 'string', 'enumValueTitles' => [], 'example' => '2', ], 'DBProxyConnectStringPort' => [ 'description' => 'The port that is associated with the database proxy endpoint.'."\n", 'type' => 'string', 'example' => '3306', ], 'DBProxyEndpointId' => [ 'description' => 'The ID of the backend database proxy endpoint.'."\n", 'type' => 'string', 'example' => '20****', ], 'DBProxyEndpointName' => [ 'description' => 'The name of the database proxy endpoint. The name can be replaced by the ID of the database proxy endpoint.'."\n", 'type' => 'string', 'example' => 'gos787jog2wk0ye1****', ], 'DBProxyVpcId' => [ 'description' => 'The VPC of the database proxy.'."\n", 'type' => 'string', 'example' => 'vpc-uf6oobt****', ], 'DBProxyVpcInstanceId' => [ 'description' => 'The ID of the database proxy instance.'."\n", 'type' => 'string', 'example' => 'rm-bp145737x5****131161274792****', ], 'DBProxyVswitchId' => [ 'description' => 'The vSwitch of the database proxy.'."\n", 'type' => 'string', 'example' => 'vsw-uf6l0pic17****', ], ], ], ], ], ], 'DBProxyEngineType' => [ 'description' => 'An internal parameter. You can ignore this parameter.'."\n", 'type' => 'string', 'example' => 'normal', ], 'DBProxyInstanceCurrentMinorVersion' => [ 'description' => 'The version of the proxy instance.'."\n", 'type' => 'string', 'example' => '1.13.11', ], 'DBProxyInstanceLatestMinorVersion' => [ 'description' => 'The latest version that is available for the proxy instance.'."\n", 'type' => 'string', 'example' => '1.13.12', ], 'DBProxyInstanceName' => [ 'description' => 'The name of the proxy instance.'."\n", 'type' => 'string', 'example' => 'gos787jog2wk0ye1****', ], 'DBProxyInstanceNum' => [ 'description' => 'The number of proxies that are enabled on the instance.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'DBProxyInstanceSize' => [ 'description' => 'This parameter is available only for ApsaraDB RDS for PostgreSQL instances. The specifications of the proxy instance that is enabled.'."\n" ."\n" .'Format: `Number of cores/Memory capacity`.'."\n" ."\n" .'For example, a value of 4/8 indicates that the proxy instance has 4 cores and 8 GB of memory.'."\n", 'type' => 'string', 'example' => '4/8', ], 'DBProxyInstanceStatus' => [ 'description' => 'The status of the proxy instance.'."\n" ."\n" .'* DBInstanceClassChanging: The specifications of the proxy instance are being changed.'."\n" .'* Creating: The proxy instance is being created.'."\n" .'* Running: The proxy instance is running.'."\n" .'* Deleting: The proxy instance is being deleted.'."\n", 'type' => 'string', 'enumValueTitles' => [], 'example' => 'Running', ], 'DBProxyInstanceType' => [ 'description' => 'The type of the database proxy that is enabled on the instance. Valid values:'."\n" ."\n" .'* 1: shared database proxy'."\n" .'* 2: dedicated database proxy'."\n" .'* 3: general-purpose database proxy'."\n" ."\n" .'> ApsaraDB RDS for PostgreSQL does not support shared database proxies.'."\n", 'type' => 'string', 'enumValueTitles' => [], 'example' => '2', ], 'DBProxyKindCode' => [ 'description' => 'An internal parameter. You do not need to specify this parameter.'."\n", 'type' => 'string', 'example' => '18', ], 'DBProxyNodes' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'DBProxyNodes' => [ 'description' => 'The proxy nodes.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'cpuCores' => [ 'description' => 'The number of CPU cores of the node.'."\n", 'type' => 'string', 'example' => '2', ], 'nodeId' => [ 'description' => 'The ID of the proxy node.'."\n", 'type' => 'string', 'example' => 'pn-xxxxxxx01', ], 'zoneId' => [ 'description' => 'The ID of the zone in which the node is deployed.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou-c', ], ], 'description' => '', ], ], ], ], 'DBProxyPersistentConnectionStatus' => [ 'description' => 'The status of persistence connections. Valid values:'."\n" ."\n" .'* **Enabled**'."\n" .'* **Disabled**'."\n" .'* **Unsupported**'."\n", 'type' => 'string', 'example' => 'Disabled', ], 'DBProxyServiceStatus' => [ 'description' => 'The status of the database proxy.'."\n" ."\n" .'* Shutdown: disabled'."\n" .'* Startup: enabled'."\n", 'type' => 'string', 'enumValueTitles' => [], 'example' => 'Startup', ], 'DbProxyEndpointItems' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'DbProxyEndpointItems' => [ 'description' => 'The proxy terminals of the instance.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the proxy terminal.'."\n", 'type' => 'object', 'properties' => [ 'DbProxyEndpointAliases' => [ 'description' => 'The description of the database proxy endpoint.'."\n", 'type' => 'string', 'example' => 'proxy-test', ], 'DbProxyEndpointName' => [ 'description' => 'The ID of the database proxy endpoint.'."\n", 'type' => 'string', 'example' => 'gos787jog2wk0ye1****', ], 'DbProxyEndpointType' => [ 'description' => 'The type of the database proxy endpoint. Valid values:'."\n" ."\n" .'* Custom: custom database proxy endpoint'."\n" .'* RWSplit: default database proxy endpoint'."\n", 'type' => 'string', 'enumValueTitles' => [], 'example' => 'RWSplit', ], 'DbProxyReadWriteMode' => [ 'description' => 'The read and write attributes of the database proxy endpoint.'."\n" ."\n" .'* ReadOnly'."\n" .'* ReadWrite'."\n", 'type' => 'string', 'enumValueTitles' => [], 'example' => 'ReadWrite', ], ], ], ], ], ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '909A69EE-71C8-4417-A0B9-FF085407E1E3', ], 'ResourceGroupId' => [ 'description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'example' => 'rg-acfmy*****', ], 'DBProxyAVZones' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'DBProxyAVZones' => [ 'description' => 'The list of zones that are available for the database proxy.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The zone that is available for the database proxy.'."\n", 'type' => 'string', 'example' => 'cn-shanghai-e', ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'RWSplitNetTypeNotExists', 'errorMessage' => 'Specified rw split net type is not eixsts.', ], [ 'errorCode' => 'InvalidDBInstanceName', 'errorMessage' => 'Specified parameter DBInstanceName is not valid.', ], [ 'errorCode' => 'InvalidInstanceLevelExtraInfo', 'errorMessage' => 'Specified class code has error extra info.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'IncorrectKindCode', 'errorMessage' => 'Current custins kindCode does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'The database instance type does not support the operation.', ], [ 'errorCode' => 'IncorrectDBInstanceEngine', 'errorMessage' => 'Current DB Instance engine does not support this operation.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBProxyInstanceMinorVersions\\": {\\n \\"DBProxyInstanceMinorVersions\\": [\\n \\"2.25.9_20251028\\"\\n ]\\n },\\n \\"DBProxyConnectStringItems\\": {\\n \\"DBProxyConnectStringItems\\": [\\n {\\n \\"DBProxyConnectString\\": \\"gos787jog2wk0ye1****-rw4rm.rwlb.rds.aliyuncs.com\\",\\n \\"DBProxyConnectStringNetType\\": \\"InnerString\\",\\n \\"DBProxyConnectStringNetWorkType\\": \\"2\\",\\n \\"DBProxyConnectStringPort\\": \\"3306\\",\\n \\"DBProxyEndpointId\\": \\"20****\\",\\n \\"DBProxyEndpointName\\": \\"gos787jog2wk0ye1****\\",\\n \\"DBProxyVpcId\\": \\"vpc-uf6oobt****\\",\\n \\"DBProxyVpcInstanceId\\": \\"rm-bp145737x5****131161274792****\\",\\n \\"DBProxyVswitchId\\": \\"vsw-uf6l0pic17****\\"\\n }\\n ]\\n },\\n \\"DBProxyEngineType\\": \\"normal\\",\\n \\"DBProxyInstanceCurrentMinorVersion\\": \\"1.13.11\\",\\n \\"DBProxyInstanceLatestMinorVersion\\": \\"1.13.12\\",\\n \\"DBProxyInstanceName\\": \\"gos787jog2wk0ye1****\\",\\n \\"DBProxyInstanceNum\\": 1,\\n \\"DBProxyInstanceSize\\": \\"4/8\\",\\n \\"DBProxyInstanceStatus\\": \\"Running\\",\\n \\"DBProxyInstanceType\\": \\"2\\",\\n \\"DBProxyKindCode\\": \\"18\\",\\n \\"DBProxyNodes\\": {\\n \\"DBProxyNodes\\": [\\n {\\n \\"cpuCores\\": \\"2\\",\\n \\"nodeId\\": \\"pn-xxxxxxx01\\",\\n \\"zoneId\\": \\"cn-hangzhou-c\\"\\n }\\n ]\\n },\\n \\"DBProxyPersistentConnectionStatus\\": \\"Disabled\\",\\n \\"DBProxyServiceStatus\\": \\"Startup\\",\\n \\"DbProxyEndpointItems\\": {\\n \\"DbProxyEndpointItems\\": [\\n {\\n \\"DbProxyEndpointAliases\\": \\"proxy-test\\",\\n \\"DbProxyEndpointName\\": \\"gos787jog2wk0ye1****\\",\\n \\"DbProxyEndpointType\\": \\"RWSplit\\",\\n \\"DbProxyReadWriteMode\\": \\"ReadWrite\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"909A69EE-71C8-4417-A0B9-FF085407E1E3\\",\\n \\"ResourceGroupId\\": \\"rg-acfmy****\\",\\n \\"DBProxyAVZones\\": {\\n \\"DBProxyAVZones\\": [\\n \\"cn-shanghai-e\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n gos787jog2wk0ye1****\\r\\n 1.13.11\\r\\n Startup\\r\\n 1\\r\\n 1.13.12\\r\\n 909A69EE-71C8-4417-A0B9-FF085407E1E3\\r\\n \\r\\n \\r\\n gos787jog2wk0ye1****\\r\\n proxy-test\\r\\n RWSplit\\r\\n ReadWrite\\r\\n \\r\\n \\r\\n \\r\\n \\r\\n gos787jog2wk0ye1****-rw4rm.rwlb.rds.aliyuncs.com\\r\\n 209090\\r\\n gos787jog2wk0ye1****\\r\\n 2\\r\\n InnerString\\r\\n 3306\\r\\n rm-bp145737x5****131161274792****\\r\\n \\r\\n \\r\\n Running\\r\\n 2\\r\\n","errorExample":""}]', 'title' => 'DescribeDBProxy', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* RDS MySQL'."\n" .'* RDS PostgreSQL'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeDBProxyEndpoint' => [ 'summary' => 'Queries the information about the database proxy endpoints of an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-bp1ja4f56s7us****', ], ], [ 'name' => 'DBProxyEndpointId', 'in' => 'query', 'schema' => [ 'description' => 'The name of the proxy terminal. You can call the DescribeDBProxy interface to query the name of the proxy terminal.'."\n", 'type' => 'string', 'required' => false, 'example' => 'keaxncrjluwu0gue****', ], ], [ 'name' => 'DBProxyConnectString', 'in' => 'query', 'schema' => [ 'description' => 'The proxy endpoint that you want to query. You can call the DescribeDBProxy interface to query the proxy endpoint.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testproxy****.rwlb.rds.aliyuncs.com', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-bp1ja4f56s7us****', ], ], [ 'name' => 'DBProxyEngineType', 'in' => 'query', 'schema' => [ 'description' => 'A reserved parameter. You do not need to specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'normal', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'DBProxyConnectString' => [ 'description' => 'The proxy endpoint queried.'."\n", 'type' => 'string', 'example' => 'testproxy****.rwlb.rds.aliyuncs.com', ], 'DBProxyConnectStringNetType' => [ 'description' => 'The network type of the proxy endpoint. Valid values:'."\n" ."\n" .'* **InnerString**: internal network'."\n" .'* **OuterString**: Internet'."\n", 'type' => 'string', 'example' => 'InnerString', ], 'DBProxyConnectStringPort' => [ 'description' => 'The port number that is associated with the proxy endpoint.'."\n", 'type' => 'string', 'example' => '3306', ], 'DBProxyEndpointId' => [ 'description' => 'The ID of the proxy endpoint.'."\n", 'type' => 'string', 'example' => 'keaxncrjluwu0gue****', ], 'DBProxyEngineType' => [ 'description' => 'An internal parameter. You can ignore this parameter.'."\n", 'type' => 'string', 'example' => 'normal', ], 'DBProxyFeatures' => [ 'description' => 'The configuration of the proxy terminal. The value of this parameter is a JSON string that consists of the following parameters:'."\n" ."\n" .'* **TransactionReadSqlRouteOptimizeStatus**: the status of the transaction splitting feature. Valid values: **0** and **1**. The value 0 indicates that the feature is disabled. The value 1 indicates that the feature is enabled.'."\n" .'* **ConnectionPersist**: the status of the connection pooling feature. Valid values: **0**, **1**, and **2**. The value 0 indicates that the connection pooling feature is disabled. The value 1 indicates that the session-level connection pooling feature is enabled. The value 2 indicates that the transaction-level connection pooling feature is enabled.'."\n" .'* **ReadWriteSpliting**: the status of the read/write splitting feature. Valid values: **0** and **1**. The value 0 indicates that the feature is disabled. The value 1 indicates that the feature is enabled.'."\n" .'* **AZProximityAccess**: the status of the nearest access feature. Valid values: **0** and **1**. The value 0 indicates that the feature is disabled. The value 1 indicates that the feature is enabled.'."\n" .'* **CausalConsistRead**: the read consistency settings. Valid values: **0**, **1**, and **2**. The value 0 indicates eventual consistency. The value 1 indicates session consistency. The value 2 indicates global consistency.'."\n" .'* **PinPreparedStmt**: an internal parameter that is available only for ApsaraDB RDS for PostgrSQL instances.'."\n" ."\n" .'> If the instance runs PostgreSQL, you can change only the value of the **ReadWriteSpliting** field. The **TransactionReadSqlRouteOptimizeStatus** and **PinPreparedStmt** fields are set to their default values 1.'."\n", 'type' => 'string', 'example' => 'TransactionReadSqlRouteOptimizeStatus:1;ConnectionPersist:0;ReadWriteSpliting:1', ], 'DBProxyNodes' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'DBProxyNodes' => [ 'description' => 'The proxy nodes that are associated with the proxy terminal.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details of the proxy node.'."\n", 'type' => 'object', 'properties' => [ 'cpuCores' => [ 'description' => 'The number of CPU cores of the node.'."\n", 'type' => 'string', 'example' => '2', ], 'nodeId' => [ 'description' => 'The ID of the node in the zone.'."\n", 'type' => 'string', 'example' => 'pn-xxxxxxx01', ], 'zoneId' => [ 'description' => 'The zone ID of the node.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou-c', ], ], ], ], ], ], 'DbProxyEndpointAliases' => [ 'description' => 'The description of the proxy terminal.'."\n", 'type' => 'string', 'example' => 'proxyterminal-test', ], 'DbProxyEndpointReadWriteMode' => [ 'description' => 'The read and write attributes of the proxy terminal. Valid values:'."\n" ."\n" .'* **ReadWrite**: The proxy terminal supports read and write requests.'."\n" .'* **ReadOnly**: The proxy terminal supports only read requests.'."\n", 'type' => 'string', 'example' => 'ReadWrite', ], 'DbProxyEndpointVswitchId' => [ 'description' => 'The vSwitch ID of the proxy terminal.'."\n", 'type' => 'string', 'example' => 'vsw-****', ], 'DbProxyEndpointVpcId' => [ 'description' => 'The virtual private cloud (VPC) ID of the proxy.', 'type' => 'string', 'example' => 'vpc-****', ], 'DbProxyEndpointZoneId' => [ 'description' => 'The zone ID of the proxy terminal.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou-c', ], 'EndpointConnectItems' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'EndpointConnectItems' => [ 'description' => 'An array that consists of the information about the proxy endpoint.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'DbProxyEndpointConnectString' => [ 'description' => 'The proxy endpoint queried.'."\n", 'type' => 'string', 'example' => 'testproxy****.rwlb.rds.aliyuncs.com', ], 'DbProxyEndpointNetType' => [ 'description' => 'The network type of the instance. Valid values:'."\n" ."\n" .'* **0**: Internet'."\n" .'* **1**: classic network'."\n" .'* **2**: virtual private cloud (VPC)'."\n", 'type' => 'string', 'example' => '2', ], 'DbProxyEndpointPort' => [ 'description' => 'The port number that is associated with the proxy endpoint. Default value: **3306**.'."\n", 'type' => 'string', 'example' => '3306', ], ], ], ], ], ], 'ReadOnlyInstanceDistributionType' => [ 'description' => 'The method that is used to assign read weights. For more information, see [Modify the latency threshold and read weights of ApsaraDB RDS for MySQL instances](~~96076~~). Valid values:'."\n" ."\n" .'* **Standard**: The system automatically assigns read weights to the instance and its read-only instances based on the specifications of these instances.'."\n" .'* **Custom**: You must manually assign read weights to the instance and its read-only instances.'."\n", 'type' => 'string', 'example' => 'Standard', ], 'ReadOnlyInstanceMaxDelayTime' => [ 'description' => 'The latency threshold that is allowed for read/write splitting. If the latency on a read-only instance exceeds the specified threshold, ApsaraDB RDS no longer forwards read requests to the read-only instance.'."\n", 'type' => 'string', 'example' => '30', ], 'CausalConsistReadTimeout' => [ 'description' => 'The timeout period for consistency reads. Unit: milliseconds. Default value: **10**. Valid values: **0** to **60000**.', 'type' => 'string', 'example' => '10', ], 'ReadOnlyInstanceWeight' => [ 'description' => 'The read weights of the instance and its read-only instances. The value of this parameter is a JSON string that consists of the following parameters:'."\n" ."\n" .'* **DBInstanceId**: the ID of the instance.'."\n" .'* **DBInstanceType**: the role of the instance. Valid values: **Master** and **ReadOnly**.'."\n" .'* **NodeID**: The IDs of the primary and secondary nodes of the cluster. An instance that runs RDS Cluster Edition refers to a cluster.'."\n" .'* **NodeType**: The node type. Valid values: **Primary** and **Secondary**.'."\n" .'* **Weight**: the read weight of the instance. The read weight increases in increments of **100** and cannot exceed **10000**.'."\n", 'type' => 'string', 'example' => '[{\\"Availability\\":\\"Available\\",\\"DBInstanceId\\":\\"rr-bp176984qewd8****\\",\\"DBInstanceType\\":\\"ReadOnly\\",\\"Weight\\":400},{\\"Availability\\":\\"Available\\",\\"DBInstanceId\\":\\"rm-bp1ja4f56s7us****\\",\\"DBInstanceType\\":\\"Master\\",\\"Weight\\":0}]', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '847BA085-B377-4BFA-8267-F82345ECE1D2', ], 'DBProxyEndpointMinSlaveCount' => [ 'description' => 'The minimum number of reserved instances.', 'type' => 'string', 'example' => '2', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'MaxscaleNotSupport', 'errorMessage' => 'Current custins can not support Maxscale.', ], [ 'errorCode' => 'InvalidEndPoint.Format', 'errorMessage' => 'The specified EndPoint is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceName', 'errorMessage' => 'Specified parameter DBInstanceName is not valid.', ], [ 'errorCode' => 'Endpoint.NotFound', 'errorMessage' => 'The specified EndPoint is not valid.', ], [ 'errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'IncorrectKindCode', 'errorMessage' => 'The current KindCode of the custins does not support the operation.', ], [ 'errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'The current database instance type does not support the operation.', ], [ 'errorCode' => 'IncorrectDBInstanceEngine', 'errorMessage' => 'Current DB Instance engine does not support this operation.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], [ 'errorCode' => 'InvalidVpcInfo.NotFound', 'errorMessage' => 'Specified VPC info does not exist.', ], ], [ [ 'errorCode' => 'Endpoint.NotFound', 'errorMessage' => 'Specified endpoint is not found.', ], [ 'errorCode' => 'Maxscale.NotFound', 'errorMessage' => 'The relative maxscale instance is not found.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBProxyConnectString\\": \\"testproxy****.rwlb.rds.aliyuncs.com\\",\\n \\"DBProxyConnectStringNetType\\": \\"InnerString\\",\\n \\"DBProxyConnectStringPort\\": \\"3306\\",\\n \\"DBProxyEndpointId\\": \\"keaxncrjluwu0gue****\\",\\n \\"DBProxyEngineType\\": \\"normal\\",\\n \\"DBProxyFeatures\\": \\"TransactionReadSqlRouteOptimizeStatus:1;ConnectionPersist:0;ReadWriteSpliting:1\\",\\n \\"DBProxyNodes\\": {\\n \\"DBProxyNodes\\": [\\n {\\n \\"cpuCores\\": \\"2\\",\\n \\"nodeId\\": \\"pn-xxxxxxx01\\",\\n \\"zoneId\\": \\"cn-hangzhou-c\\"\\n }\\n ]\\n },\\n \\"DbProxyEndpointAliases\\": \\"proxyterminal-test\\",\\n \\"DbProxyEndpointReadWriteMode\\": \\"ReadWrite\\",\\n \\"DbProxyEndpointVswitchId\\": \\"vsw-****\\",\\n \\"DbProxyEndpointVpcId\\": \\"vpc-****\\",\\n \\"DbProxyEndpointZoneId\\": \\"cn-hangzhou-c\\",\\n \\"EndpointConnectItems\\": {\\n \\"EndpointConnectItems\\": [\\n {\\n \\"DbProxyEndpointConnectString\\": \\"testproxy****.rwlb.rds.aliyuncs.com\\",\\n \\"DbProxyEndpointNetType\\": \\"2\\",\\n \\"DbProxyEndpointPort\\": \\"3306\\"\\n }\\n ]\\n },\\n \\"ReadOnlyInstanceDistributionType\\": \\"Standard\\",\\n \\"ReadOnlyInstanceMaxDelayTime\\": \\"30\\",\\n \\"CausalConsistReadTimeout\\": \\"10\\",\\n \\"ReadOnlyInstanceWeight\\": \\"[{\\\\\\\\\\\\\\"Availability\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Available\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"DBInstanceId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"rm-2z****\\\\\\\\\\\\\\"，\\\\\\\\\\\\\\"DBInstanceType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Master\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"NodeId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"rn-t2****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"NodeType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Primary\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Weight\\\\\\\\\\\\\\":0}, {\\\\\\\\\\\\\\"Availability\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Available\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"DBInstanceId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"rm-2z****\\\\\\\\\\\\\\"，\\\\\\\\\\\\\\"DBInstanceType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Master\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"NodeId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"rn-z9****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"NodeType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Secondary\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Weight\\\\\\\\\\\\\\":400}, {\\\\\\\\\\\\\\"Availability\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Available\\\\\\\\\\\\\\",,\\\\\\\\\\\\\\"DBInstanceId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"rm-2z****\\\\\\\\\\\\\\"，\\\\\\\\\\\\\\"DBInstanceType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Master\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"NodeId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"rn-1c****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"NodeType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Secondary\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Weight\\\\\\\\\\\\\\":400}]]\\",\\n \\"RequestId\\": \\"847BA085-B377-4BFA-8267-F82345ECE1D2\\",\\n \\"DBProxyEndpointMinSlaveCount\\": \\"2\\"\\n}","errorExample":""},{"type":"xml","example":"\\n InnerString\\n TransactionReadSqlRouteOptimizeStatus:1;ConnectionPersist:0;ReadWriteSpliting:1\\n 847BA085-B377-4BFA-8267-F82345ECE1D2\\n [{\\\\\\"Availability\\\\\\":\\\\\\"Available\\\\\\",\\\\\\"DBInstanceId\\\\\\":\\\\\\"rr-bp****\\\\\\",\\\\\\"DBInstanceType\\\\\\":\\\\\\"ReadOnly\\\\\\",\\\\\\"NodeId\\\\\\":\\\\\\"rr-bp****\\\\\\",\\\\\\"NodeType\\\\\\":\\\\\\"ReadOnly\\\\\\",\\\\\\"Weight\\\\\\":400}, {\\\\\\"Availability\\\\\\":\\\\\\"Available\\\\\\",\\\\\\"DBInstanceId\\\\\\":\\\\\\"rm-2z****\\\\\\"，\\\\\\"DBInstanceType\\\\\\":\\\\\\"Master\\\\\\",\\\\\\"NodeId\\\\\\":\\\\\\"rm-2z****-instance-2\\\\\\",\\\\\\"NodeType\\\\\\":\\\\\\"Secondary\\\\\\",\\\\\\"Weight\\\\\\":400}, {\\\\\\"Availability\\\\\\":\\\\\\"Available\\\\\\",\\\\\\"DBInstanceId\\\\\\":\\\\\\"rm-2z****\\\\\\"，\\\\\\"DBInstanceType\\\\\\":\\\\\\"Master\\\\\\",\\\\\\"NodeId\\\\\\":\\\\\\"rm-2z****-instance-3\\\\\\",\\\\\\"NodeType\\\\\\":\\\\\\"Secondary\\\\\\",\\\\\\"Weight\\\\\\":400}, {\\\\\\"Availability\\\\\\":\\\\\\"Available\\\\\\",,\\\\\\"DBInstanceId\\\\\\":\\\\\\"rm-2z****\\\\\\"，\\\\\\"DBInstanceType\\\\\\":\\\\\\"Master\\\\\\",\\\\\\"NodeId\\\\\\":\\\\\\"rm-2z****-instance-1\\\\\\",\\\\\\"NodeType\\\\\\":\\\\\\"Primary\\\\\\",\\\\\\"Weight\\\\\\":0}]]\\n Standard\\n 30\\n ReadWrite\\n proxyterminal-test\\n keaxncrjluwu0gue****\\n 3306\\n testproxy****.rwlb.rds.aliyuncs.com\\n normal\\n \\n 3306\\n testproxy****.rwlb.rds.aliyuncs.com\\n 2\\n \\n","errorExample":""}]', 'title' => 'DescribeDBProxyEndpoint', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* RDS MySQL'."\n" .'* RDS PostgreSQL'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeDBProxyPerformance' => [ 'summary' => 'Queries the performance data of the database proxy for an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-t4n3axxxxx', ], ], [ 'name' => 'DBProxyInstanceType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the database proxy instance. Valid values:'."\n" ."\n" .'* common: the general-purpose database proxy'."\n" .'* exclusive: the dedicated database proxy'."\n", 'type' => 'string', 'required' => false, 'example' => 'DedicatedProxy', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2019-09-19T01:00:00Z', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => 'The end of the time range to query. The end time must be later than the start time. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2019-09-21T18:00:00Z', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'MetricsName', 'in' => 'query', 'schema' => [ 'description' => 'The performance metrics that you want to query.'."\n" ."\n" .'If the instance runs MySQL, you can query only the **Maxscale_CpuUsage** performance metric, which indicates the CPU utilization of the instance.'."\n" ."\n" .'If the instance runs PostgreSQL, you can query the following performance metrics:'."\n" ."\n" .'* **Maxscale_TotalConns**: the number of connections per second'."\n" .'* **Maxscale_CurrentConns**: the number of connections that are established'."\n" .'* **Maxscale_DownFlows**: outbound traffic'."\n" .'* **Maxscale_UpFlows**: inbound traffic'."\n" .'* **Maxscale_QPS**: QPS'."\n" .'* **Maxscale_MemUsage**: memory usage'."\n" .'* **Maxscale_CpuUsage**: CPU utilization'."\n" ."\n" .'If you want to query more than one performance metric, separate the performance metrics with commas (,). You can specify up to six performance metrics in a single request.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Maxscale_CpuUsage', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-t4n3axxxxx', ], ], [ 'name' => 'DBProxyEngineType', 'in' => 'query', 'schema' => [ 'description' => 'A reserved parameter. You do not need to specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'normal', ], ], [ 'name' => 'Dimension', 'in' => 'query', 'schema' => [ 'description' => 'Dimension.', 'type' => 'string', 'required' => false, 'example' => 'service', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'EndTime' => [ 'description' => 'The end time of the query.'."\n", 'type' => 'string', 'example' => '2019-09-21T18:00:00Z', ], 'StartTime' => [ 'description' => 'The start time of the query.'."\n", 'type' => 'string', 'example' => '2019-09-19T01:00:00Z', ], 'DBInstanceId' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'lsmexxxxxxx', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'DD31056F-A0CE-41D7-AD39-689B6ABAE982', ], 'DBProxyEngineType' => [ 'description' => 'An internal parameter. You do not need to specify this parameter.'."\n", 'type' => 'string', 'example' => 'normal', ], 'PerformanceKeys' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'PerformanceKey' => [ 'description' => 'The performance list.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'ValueFormat' => [ 'description' => 'The format in which the value of the performance metric is returned.'."\n", 'type' => 'string', 'example' => 'docker_container_cpu', ], 'Key' => [ 'description' => 'The performance parameter.'."\n", 'type' => 'string', 'example' => 'cpu_ratio', ], 'Values' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'PerformanceValue' => [ 'description' => 'The performance metrics.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Date' => [ 'description' => 'The date and time when the value of the performance metric was recorded. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2019-10-10T09:00:00Z', ], 'Value' => [ 'description' => 'The value of the performance metric.'."\n", 'type' => 'string', 'example' => '2.83', ], ], ], ], ], ], 'Service' => [ 'description' => 'The service dimension.', 'type' => 'string', 'example' => 'reserve_3', ], 'Node' => [ 'type' => 'string', ], 'Server' => [ 'type' => 'string', ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidDBInstanceName', 'errorMessage' => 'Specified parameter DBInstanceName is not valid.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'NoAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for account. We recommend that you add a payment method.', ], ], 403 => [ [ 'errorCode' => 'ParamNotFound', 'errorMessage' => 'The parameter is not found for the interface.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'Endpoint.NotFound', 'errorMessage' => 'Specified endpoint is not found.', ], [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', ], [ 'errorCode' => 'Maxscale.NotFound', 'errorMessage' => 'The relative maxscale instance is not found.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 408 => [ [ 'errorCode' => 'InvalidOthers.Timeout', 'errorMessage' => 'Query timed out.Please try again or narrow down the query scope.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"EndTime\\": \\"2019-09-21T18:00:00Z\\",\\n \\"StartTime\\": \\"2019-09-19T01:00:00Z\\",\\n \\"DBInstanceId\\": \\"lsme****\\",\\n \\"RequestId\\": \\"DD31056F-A0CE-41D7-AD39-689B6ABAE982\\",\\n \\"DBProxyEngineType\\": \\"normal\\",\\n \\"PerformanceKeys\\": {\\n \\"PerformanceKey\\": [\\n {\\n \\"ValueFormat\\": \\"docker_container_cpu\\",\\n \\"Key\\": \\"cpu_ratio\\",\\n \\"Values\\": {\\n \\"PerformanceValue\\": [\\n {\\n \\"Date\\": \\"2019-10-10T09:00:00Z\\",\\n \\"Value\\": \\"2.83\\"\\n }\\n ]\\n },\\n \\"Service\\": \\"mr-xxx\\",\\n \\"Node\\": \\"pn-xxx\\",\\n \\"Server\\": \\"rn-xxx\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\nlsmexxxxxxx\\nDD31056F-A0CE-41D7-AD39-689B6ABAE982\\n\\n \\n \\n \\n 2.83\\n 2019-10-10T09:00:00Z\\n \\n \\n cpu_ratio\\n docker_container_cpu\\n \\n\\n2019-10-10T09:39:28Z\\n2019-10-01T09:39:28Z\\n","errorExample":""}]', 'title' => 'DescribeDBProxyPerformance', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" ."\n" .'> Starting October 17, 2023, ApsaraDB RDS provides a dedicated proxy free of charge for each ApsaraDB RDS for MySQL instance on RDS Cluster Edition. For more information, see [\\[Special offers/Price changes\\] One proxy is provided free of charge for ApsaraDB RDS for MySQL instances on RDS Cluster Edition](~~2555466~~).'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> Before you call this operation, read the following documentation and make sure that you fully understand the prerequisites and impacts of this operation.'."\n" ."\n" .'* [View the monitoring data of an ApsaraDB RDS for MySQL instance](~~194241~~)'."\n" .'* [View the monitoring data of an ApsaraDB RDS for PostgreSQL instance](~~418275~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'GetDbProxyInstanceSsl' => [ 'summary' => 'Queries the SSL encryption settings for a dedicated proxy endpoint of an ApsaraDB RDS for MySQL instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'DbInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-t4n3axxxxx', ], ], [ 'name' => 'DbInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-t4n3axxxxx', ], ], [ 'name' => 'DBProxyEngineType', 'in' => 'query', 'schema' => [ 'description' => 'A reserved parameter. You do not need to specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'normal', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'DbProxyCertListItems' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'DbProxyCertListItems' => [ 'description' => 'An array that consists of SSL encryption settings.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'CertCommonName' => [ 'description' => 'The dedicated proxy endpoint for which SSL encryption is enabled.'."\n", 'type' => 'string', 'example' => 'test1234.rwlb.rds.aliyuncs.com', ], 'DbInstanceName' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-t4n3axxxxx', ], 'EndpointName' => [ 'description' => 'The ID of the dedicated proxy endpoint.'."\n", 'type' => 'string', 'example' => 'buxxxxxxx', ], 'EndpointType' => [ 'description' => 'The default identifier of the dedicated proxy endpoint. The value is fixed as **RWSplit**.'."\n", 'type' => 'string', 'example' => 'RWSplit', ], 'SslExpiredTime' => [ 'description' => 'The time at which the certificate expires.'."\n", 'type' => 'string', 'example' => '2021-12-16T08:43:20Z', ], ], ], ], ], ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'D330E60C-8AAA-4D63-8F64-5B78F4692F98', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidVpcInstanceId', 'errorMessage' => 'The specified VPC instance ID is invalid.', ], [ 'errorCode' => 'InvalidDBInstanceName', 'errorMessage' => 'Specified parameter DBInstanceName is not valid.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'The current database instance type does not support the operation.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance does not exist or is not supported.', ], [ 'errorCode' => 'Endpoint.NotFound', 'errorMessage' => 'The specified endpoint is not found.', ], [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', ], [ 'errorCode' => 'Maxscale.NotFound', 'errorMessage' => 'The related maxscale instance is not found.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"DbProxyCertListItems\\": {\\n \\"DbProxyCertListItems\\": [\\n {\\n \\"CertCommonName\\": \\"test1234.rwlb.rds.aliyuncs.com\\",\\n \\"DbInstanceName\\": \\"rm-t4n3a****\\",\\n \\"EndpointName\\": \\"bu****\\",\\n \\"EndpointType\\": \\"RWSplit\\",\\n \\"SslExpiredTime\\": \\"2021-12-16T08:43:20Z\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"D330E60C-8AAA-4D63-8F64-5B78F4692F98\\"\\n}","errorExample":""},{"type":"xml","example":"\\nD330E60C-8AAA-4D63-8F64-5B78F4692F98\\n\\n \\n buxxxxxxx\\n RWSplit\\n test1234.rwlb.rds.aliyuncs.com\\n 2021-12-16T08:43:20Z\\n rm-t4n3axxxxx\\n \\n\\n","errorExample":""}]', 'title' => 'GetDbProxyInstanceSsl', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'RDS MySQL'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ModifyReadWriteSplittingConnection' => [ 'summary' => 'Modifies the latency threshold of the read/write splitting link and the read weights of a primary instance and its read-only instances.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the primary instance. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5xxxxxxx', ], ], [ 'name' => 'ConnectionStringPrefix', 'in' => 'query', 'schema' => [ 'description' => 'The prefix of the read/write splitting endpoint. The prefix must be unique. It can be up to 30 characters in length and can contain lowercase letters and hyphens (-). It must start with a lowercase letter.'."\n" ."\n" .'> The default prefix consists of the name of the primary instance followed by the letters rw.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rm-m5xxxxxxxxrw.mysql.rds.aliyuncs.com', ], ], [ 'name' => 'Port', 'in' => 'query', 'schema' => [ 'description' => 'The port that is associated with the read/write splitting endpoint.'."\n", 'type' => 'string', 'required' => false, 'example' => '3306', ], ], [ 'name' => 'MaxDelayTime', 'in' => 'query', 'schema' => [ 'description' => 'The latency threshold that is allowed by the read/write splitting link. Unit: seconds. If the latency on a read-only instance exceeds the specified threshold, the system no longer routes read requests to the read-only instance. If you do not specify this parameter, the default value of this parameter is retained.'."\n" ."\n" .'> * If the primary instance runs SQL Server 2017 on RDS Cluster Edition, the **MaxDelayTime** parameter is not supported.'."\n" .'> * You must specify at least one of **MaxDelayTime** and **DistributionType**.', 'type' => 'string', 'required' => false, 'example' => '12', ], ], [ 'name' => 'DistributionType', 'in' => 'query', 'schema' => [ 'description' => 'The method that is used to assign read weights. Valid values:'."\n" ."\n" .'* **Standard**: The system automatically assigns read weights to the primary and read-only instances based on the specifications of these instances.'."\n" .'* **Custom**: You must manually assign a read weight to each instance.'."\n" ."\n" .'> You must specify at least one of **MaxDelayTime** and **DistributionType**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Standard', ], ], [ 'name' => 'Weight', 'in' => 'query', 'schema' => [ 'description' => 'The read weights of the primary instance and its read-only instances. A read weight must be a multiple of 100 and cannot exceed 10,000.'."\n" ."\n" .'* For ApsaraDB RDS instances, the value of this parameter is in the following format: `{"":,"master":,"slave":}`.'."\n" .'* For ApsaraDB MyBase instances, the value of this parameter is in the following format: `[{"instanceName":"","weight":,"role":"master"},{"instanceName":"","weight":,"role":"slave"},{"instanceName":"","weight":,"role":"master"}]`'."\n" ."\n" .'> '."\n" ."\n" .'* This parameter must be specified when **DistributionType** is set to **Custom**.'."\n" ."\n" .'* If **DistributionType** is set to **Standard**, this parameter is invalid.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"rm-bp1**********":800,"master":400,"slave":400}', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '5A77D650-27A1-4E08-AD9E-59008EDB6927', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'ReadUniformNetTypeNotExists', 'errorMessage' => 'The specified uniform read only network type does not exist.', ], [ 'errorCode' => 'ReadDBInstance.NotFound', 'errorMessage' => 'The Current DB Instance has not read-only instance.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'ReadDBInstance.NotFound', 'errorMessage' => 'The current database instance does not contain any read only instance.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5A77D650-27A1-4E08-AD9E-59008EDB6927\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"7463B73D-35CC-4D19-A010-6B8D65D242EF\\",\\n \\"HostId\\": \\"rds.aliyuncs.com\\",\\n \\"Code\\": \\"UnsupportedOperation\\",\\n \\"Message\\": \\"The specified action is not supported.\\"\\n}"},{"type":"xml","example":"\\n\\n\\t5A77D650-27A1-4E08-AD9E-59008EDB6927\\n\\n\\t\\n","errorExample":""}]', 'title' => 'ModifyReadWriteSplittingConnection', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* SQL Server'."\n" ."\n" .'### [](#)Prerequisites'."\n" ."\n" .'Before you call this operation, make sure that the following requirements are met:'."\n" ."\n" .'* The shared proxy feature is enabled for your ApsaraDB RDS for MySQL instance.'."\n" ."\n" .'* The read/write splitting feature is enabled for your ApsaraDB RDS for MySQL instance.'."\n" ."\n" .'* The instance must run one of the following database engine versions and RDS editions:'."\n" ."\n" .' * MySQL 5.7 on RDS High-availability Edition with local disks'."\n" .' * MySQL 5.6'."\n" .' * SQL Server on RDS Cluster Edition'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeDBInstanceProxyConfiguration' => [ 'summary' => 'Queries the settings of shared proxies that are enabled on an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-uf6wjk5xxxxxxxxxx', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'AttacksProtectionConfiguration' => [ 'description' => 'Indicates whether the mechanism that is used to mitigate brute-force attacks is enabled:'."\n" ."\n" .'* **Enable**'."\n" .'* **Disable**'."\n" ."\n" .'The return value is a JSON string. Example:'."\n" ."\n" .' {"status":"Disable", "check_interval_seconds": 60,'."\n" .' "max_failed_login_attempts": 60, "blocking_seconds": 600}'."\n" ."\n" .'Description:'."\n" ."\n" .'* Each client allows {max_failed_login_attempts} logon attempts that fail due to incorrect passwords within {check_interval_seconds} seconds. If one more such attempt is conducted, the client must wait for {blocking_seconds} seconds before you can try again.'."\n" ."\n" .'* Valid values:'."\n" ."\n" .' * check_interval_seconds: **30 to 600**. Unit: seconds.'."\n" .' * max_failed_login_attempts: **10 to 5000**. Unit: times.'."\n" .' * blocking_seconds: **30 to 3600**. Unit: seconds.'."\n", 'type' => 'string', 'example' => '{\\"check_interval_seconds\\":\\"0\\",\\"max_failed_login_attempts\\":\\"0\\",\\"blocking_seconds\\":\\"0\\",\\"status\\":\\"Disable\\"}', ], 'PersistentConnectionsConfiguration' => [ 'description' => 'Indicates whether the short-lived connection optimization feature is enabled.'."\n" ."\n" .'* **Enable**'."\n" .'* **Disable**'."\n" ."\n" .'In this case, the return value is a JSON string. Examples:'."\n" ."\n" .' {"status":"Disable"}.'."\n", 'type' => 'string', 'example' => '{\\"status\\":\\"Disable\\"}', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'E9DD55F4-1A5F-48CA-BA57-DFB3CA8C4C34', ], 'TransparentSwitchConfiguration' => [ 'description' => 'Indicates whether the transparent switchover feature is enabled.'."\n" ."\n" .'* **Enable**'."\n" .'* **Disable**'."\n" ."\n" .'The return value is a JSON string. Example:'."\n" ."\n" .' {"status":"Enable"}'."\n", 'type' => 'string', 'example' => '{\\"status\\":\\"Enable\\"}', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"AttacksProtectionConfiguration\\": \\"{\\\\\\\\\\\\\\"check_interval_seconds\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"0\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"max_failed_login_attempts\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"0\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"blocking_seconds\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"0\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"status\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Disable\\\\\\\\\\\\\\"}\\",\\n \\"PersistentConnectionsConfiguration\\": \\"{\\\\\\\\\\\\\\"status\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Disable\\\\\\\\\\\\\\"}\\",\\n \\"RequestId\\": \\"E9DD55F4-1A5F-48CA-BA57-DFB3CA8C4C34\\",\\n \\"TransparentSwitchConfiguration\\": \\"{\\\\\\\\\\\\\\"status\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Enable\\\\\\\\\\\\\\"}\\"\\n}","errorExample":""},{"type":"xml","example":"\\n\\n\\t{"status":"Disable"}\\n\\t{"status":"Enable"}\\n\\t{"check_interval_seconds":"0","max_failed_login_attempts":"0","blocking_seconds":"0","status":"Disable"}\\n\\tE9DD55F4-1A5F-48CA-BA57-DFB3CA8C4C34\\n\\n\\t\\n","errorExample":""}]', 'title' => 'DescribeDBInstanceProxyConfiguration', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* SQL Server'."\n" ."\n" .'### [](#)Feature description'."\n" ."\n" .'This operation is used to query the shared proxy settings of an instance that runs MySQL or the read/write splitting settings of an instance that runs SQL Server. For more information about how to query the dedicated proxy settings of an ApsaraDB RDS for MySQL instance, see [DescribeDBProxy](~~610506~~).'."\n" ."\n" .'### [](#)Prerequisites'."\n" ."\n" .'Before you call this operation, make sure that the following requirements are met:'."\n" ."\n" .'* The shared proxy feature must be enabled for the primary instance.'."\n" .'* The read/write splitting feature must be enabled for the primary instance.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'AllocateReadWriteSplittingConnection' => [ 'summary' => 'Applies for a read-only routing endpoint for an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The primary instance ID. You can call the DescribeDBInstances operation to query the primary instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-uf6wjk5xxxxxxx', ], ], [ 'name' => 'ConnectionStringPrefix', 'in' => 'query', 'schema' => [ 'description' => 'The prefix of the read-only routing endpoint. The prefix must be unique. It can be up to 30 characters in length and can contain lowercase letters and hyphens (-). It must start with a lowercase letter.'."\n" ."\n" .'> The default prefix consists of the name of the primary instance followed by the letters rw.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rr-m5exxxxx-rw.mysql.rds.aliyuncs.com', ], ], [ 'name' => 'Port', 'in' => 'query', 'schema' => [ 'description' => 'The port that is associated with the read-only routing endpoint. Valid values: 1000 to 5999. Default value: 1433.'."\n", 'type' => 'string', 'required' => false, 'example' => '1433', ], ], [ 'name' => 'MaxDelayTime', 'in' => 'query', 'schema' => [ 'description' => 'The threshold of the latency that is allowed on the read-only instances. Valid values: 0 to 7200. Default value: 30. Unit: seconds.'."\n" ."\n" .'> If the latency on a read-only instance exceeds the specified threshold, ApsaraDB RDS does not forward read requests to the read-only instance.'."\n", 'type' => 'string', 'required' => false, 'example' => '30', ], ], [ 'name' => 'NetType', 'in' => 'query', 'schema' => [ 'description' => 'The network type of the read-only routing endpoint. Valid values:'."\n" ."\n" .'* **Internet**'."\n" .'* **Intranet**'."\n" ."\n" .'> The default value is Intranet. Make sure that the network type of the read-only routing endpoint is the same as that of the primary instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Intranet', 'default' => '0', ], ], [ 'name' => 'DistributionType', 'in' => 'query', 'schema' => [ 'description' => 'The method that is used to assign read weights. Valid values:'."\n" ."\n" .'* **Standard**: The system automatically assigns read weights to the primary and read-only instances based on the specifications of these instances.'."\n" .'* **Custom**: You must manually assign a read weight to each instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Standard', 'default' => '0', ], ], [ 'name' => 'Weight', 'in' => 'query', 'schema' => [ 'description' => 'The read weights of the primary instance and its read-only instances. The read weight is increased in increments of 100. The maximum value is 10000.'."\n" ."\n" .'* For ApsaraDB RDS instances, the value of this parameter is in the following format: `{"":,"master":,"slave":}`.'."\n" .'* For ApsaraDB MyBase instances, the value of this parameter is in the following format: `[{"instanceName":"","weight":,"role":"master"},{"instanceName":"","weight":,"role":"slave"},{"instanceName":"","weight":,"role":"master"}]`'."\n" ."\n" .'> '."\n" ."\n" .'* This parameter must be specified when **DistributionType** is set to **Custom**.'."\n" ."\n" .'* If **DistributionType** is set to **Standard**, this parameter is invalid.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"rm-bp1**********":800,"master":400,"slave":400}', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '4C467B38-3910-447D-87BC-AC049166F216', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4C467B38-3910-447D-87BC-AC049166F216\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 4C467B38-3910-447D-87BC-AC049166F216\\n","errorExample":""}]', 'title' => 'AllocateReadWriteSplittingConnection', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* SQL Server'."\n" ."\n" .'### [](#)Feature description'."\n" ."\n" .'If read-only instances are attached to a primary ApsaraDB RDS for SQL Server instance, you can call this operation to apply for a unified read-only routing endpoint for the primary instance. After you apply for a read-only routing endpoint for a primary instance, the existing endpoints of the primary instance and its read-only instances remain valid. In addition, you can still apply for internal and public endpoints.'."\n" ."\n" .'### [](#)Prerequisites'."\n" ."\n" .'Before you call this operation, make sure that the following requirements are met:'."\n" ."\n" .'* The shared proxy feature is enabled for your ApsaraDB RDS for MySQL instance.'."\n" ."\n" .'* The instance is in the Running state.'."\n" ."\n" .'* Read-only instances are attached to the primary instance.'."\n" ."\n" .'* The instance does not have an ongoing Data Transmission Service (DTS) migration task.'."\n" ."\n" .'* The instance runs one of the following database versions and RDS editions:'."\n" ."\n" .' * SQL Server on RDS Cluster Edition'."\n" .' * MySQL 5.7 on RDS High-availability Edition (with local disks)'."\n" .' * MySQL 5.6'."\n", ], 'ReleaseReadWriteSplittingConnection' => [ 'summary' => 'Releases the read/write splitting endpoint of an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the primary instance. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-uf6wjk5xxxxxxx', ], ], [ 'name' => 'RWAddressType', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => [ 'type' => 'string', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '5A77D650-27A1-4E08-AD9E-59008EDB6927', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5A77D650-27A1-4E08-AD9E-59008EDB6927\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"7463B73D-35CC-4D19-A010-6B8D65D242EF\\",\\n \\"HostId\\": \\"rds.aliyuncs.com\\",\\n \\"Code\\": \\"UnsupportedOperation\\",\\n \\"Message\\": \\"The specified action is not supported.\\"\\n}"},{"type":"xml","example":"\\n\\n\\t5A77D650-27A1-4E08-AD9E-59008EDB6927\\n\\n\\t\\n","errorExample":""}]', 'title' => 'ReleaseReadWriteSplittingConnection', 'description' => '### Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* SQL Server'."\n" ."\n" .'### Prerequisites'."\n" ."\n" .'Before you call this operation, make sure that the following requirements are met:'."\n" ."\n" .'* The shared proxy feature is enabled for your ApsaraDB RDS for MySQL instance.'."\n" ."\n" .'* The read/write splitting feature is enabled for the instance.'."\n" ."\n" .'* The instance must run one of the following database engine versions and RDS editions:'."\n" ."\n" .' * MySQL 5.7 on RDS High-availability Edition (with local disks)'."\n" .' * MySQL 5.6'."\n" .' * SQL Server on RDS Cluster Edition', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'CalculateDBInstanceWeight' => [ 'summary' => 'Queries system-assigned read weights.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The primary instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5xxxxxxx', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Items' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'DBInstanceWeight' => [ 'description' => 'An array that consists of information about the system-assigned read weight.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'DBInstanceId' => [ 'description' => 'The instance ID'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5xxxxxxx', ], 'DBInstanceType' => [ 'description' => 'The type of the instance. Valid values:'."\n" ."\n" .'* **Master**: primary instance'."\n" .'* **Readonly**: read-only instance'."\n", 'type' => 'string', 'example' => 'Master', ], 'ReadonlyInstanceSQLDelayedTime' => [ 'description' => 'The latency at which the read-only instances replicate data. The read-only instances replicate data from the primary instance at the latency that is specified by the **ReadonlyInstanceSQLDelayedTime** parameter. Unit: seconds.'."\n", 'type' => 'string', 'example' => '30', ], 'Weight' => [ 'description' => 'The read weight that the system calculates in real time for the instance.'."\n", 'type' => 'string', 'example' => '100', ], ], ], ], ], ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'C816A4BF-A6EC-4722-95F9-2055859CCFD2', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance engine and type does not support operations.', ], [ 'errorCode' => 'IncorrectDBInstanceConnType', 'errorMessage' => 'Current DB instance conn type does not support this operation.', ], [ 'errorCode' => 'IncorrectDBType', 'errorMessage' => 'The current DB type does not support this operation.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'Invalid DBInstanceId NotFound.', ], [ 'errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', ], [ 'errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'Specified DB instance class is not found.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Items\\": {\\n \\"DBInstanceWeight\\": [\\n {\\n \\"DBInstanceId\\": \\"rm-uf6wjk5xxxxxxx\\",\\n \\"DBInstanceType\\": \\"Master\\",\\n \\"ReadonlyInstanceSQLDelayedTime\\": \\"30\\",\\n \\"Weight\\": \\"100\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"C816A4BF-A6EC-4722-95F9-2055859CCFD2\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 4139E1C3-0480-5A50-B327-23E6B1028906\\n \\n \\n master\\n ******\\n Readonly\\n 400\\n \\n \\n master\\n ******\\n Master\\n 0\\n \\n \\n slave\\n ******\\n Master\\n 1600\\n \\n \\n","errorExample":""}]', 'title' => 'CalculateDBInstanceWeight', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* SQL Server'."\n" ."\n" .'### [](#)Feature description'."\n" ."\n" .'When the [read/write splitting](~~51073~~) feature is enabled, this operation is used to calculate system-assigned read weights. For more information about custom read weights, see [DescribeDBInstanceNetInfo](~~610423~~).'."\n" ."\n" .'### [](#)Prerequisites'."\n" ."\n" .'Before you call this operation, make sure that the following requirements are met:'."\n" ."\n" .'* If the instance runs MySQL, the instance uses a shared proxy.'."\n" ."\n" .'* The instance runs one of the following MySQL versions and RDS editions:'."\n" ."\n" .' * MySQL 5.7 on RDS High-availability Edition (with local disks)'."\n" .' * MySQL 5.6'."\n" .' * SQL Server on RDS Cluster Edition'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'AttachWhitelistTemplateToInstance' => [ 'summary' => 'Associates a whitelist template with an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', ], 'parameters' => [ [ 'name' => 'TemplateId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the whitelist template. You can call the DescribeAllWhitelistTemplate operation to obtain the ID of the whitelist template.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '412', ], ], [ 'name' => 'InsName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-bp191w771kd3****', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the resource group. For more information about resource groups, see Resource groups.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy*****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResponse', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Code' => [ 'description' => 'The response code returned. Valid values:'."\n" ."\n" .'* **200**: success'."\n" .'* **400**: client error'."\n" .'* **401**: identity authentication failed'."\n" .'* **404**: request page not found'."\n" .'* **500**: server error'."\n", 'type' => 'string', 'enumValueTitles' => [], 'example' => '200', ], 'Data' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => 'The status code returned. Valid values:'."\n" ."\n" .'* **ok**: The request is successful.'."\n" .'* **error**: The request fails.'."\n", 'type' => 'string', 'enumValueTitles' => [], 'example' => 'ok', ], ], ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code returned. Valid values:'."\n" ."\n" .'* **200**: success'."\n" .'* **400**: client error'."\n" .'* **500**: server error'."\n", 'type' => 'integer', 'format' => 'int32', 'enumValueTitles' => [], 'example' => '200', ], 'Message' => [ 'description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'success', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '08A3B71B-FE08-4B03-974F-CC7EA6DB1828', ], 'Success' => [ 'description' => 'Indicates whether the request is successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'enumValueTitles' => [], 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidSecurityIPList.QuotaExceeded', 'errorMessage' => 'Specified security IP list is not valid: Exceeding the allowed amount of IP address in the list.', ], [ 'errorCode' => 'InvalidParameterTemplateId', 'errorMessage' => 'The parameter templateId is invalid.', ], [ 'errorCode' => 'InvalidDBInstanceName.TooMuchItems', 'errorMessage' => 'The number of DB instance Names should be no more than 20.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], [ [ 'errorCode' => 'WhitelistTemplateRelationToCustinsId.EXISTS', 'errorMessage' => 'Whitelist Template relation to CustinsId exists.', ], [ 'errorCode' => 'WhitelistIPLength.Forbidden', 'errorMessage' => 'Whitelist ip length exceeeds the limit.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'WhitelistTemplateId.NotFound', 'errorMessage' => 'Whitelist Template id not found.', ], [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'Invalid DBInstanceId NotFound.', ], [ 'errorCode' => 'InsName.NotFound', 'errorMessage' => 'InsName not found.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Data\\": {\\n \\"Status\\": \\"ok\\"\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"08A3B71B-FE08-4B03-974F-CC7EA6DB1828\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'AttachWhitelistTemplateToInstance', 'description' => '### Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n", ], 'CreateServiceLinkedRole' => [ 'summary' => 'Creates a service-linked role.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'ServiceLinkedRole', 'in' => 'query', 'schema' => [ 'description' => 'The name of the service-linked role.'."\n" ."\n" .'* **AliyunServiceRoleForRdsPgsqlOnEcs**: the service-linked role for ApsaraDB RDS for PostgreSQL.'."\n" .'* **AliyunServiceRoleForRDSProxyOnEcs**: the service-linked role for the database proxy feature of ApsaraDB RDS for PostgreSQL.'."\n", 'type' => 'string', 'required' => true, 'example' => 'AliyunServiceRoleForRdsPgsqlOnEcs', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'B4CAF581-2AC7-41AD-8940-D56DF7AA****', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Caller.NotSupport', 'errorMessage' => 'The Caller Not Support This Operation .', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AA****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n B4CAF581-2AC7-41AD-8940-D56DF7AA****\\n","errorExample":""}]', 'title' => 'CreateServiceLinkedRole', 'description' => '### Supported database engine'."\n" ."\n" .'PostgreSQL'."\n" ."\n" .'### References'."\n" ."\n" .'> Before you call this operation, read the following documentation and make sure that you fully understand the prerequisites and impacts of this operation.'."\n" ."\n" .'[Service-linked roles](~~342840~~)'."\n", ], 'DetachWhitelistTemplateToInstance' => [ 'summary' => 'Disassociates a whitelist template from an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', ], 'parameters' => [ [ 'name' => 'TemplateId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the whitelist template. You can call the DescribeAllWhitelistTemplate operation to obtain the ID of the whitelist template.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '412', ], ], [ 'name' => 'InsName', 'in' => 'query', 'schema' => [ 'description' => 'The instance name.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-bp191w771k******', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The resource group ID. For more information about resource groups, see Resource groups.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmz3kjr******', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResponse', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Code' => [ 'description' => 'The response code. Valid values:'."\n" ."\n" .'* **200**: success'."\n" .'* **400**: client error'."\n" .'* **401**: identity authentication failed'."\n" .'* **404**: request page not found'."\n" .'* **500**: server error'."\n", 'type' => 'string', 'enumValueTitles' => [], 'example' => '200', ], 'Data' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => 'The status code returned. Valid values:'."\n" ."\n" .'* **ok**: The request is successful.'."\n" .'* **error**: The request fails.'."\n", 'type' => 'string', 'enumValueTitles' => [], 'example' => 'ok', ], ], ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code returned. Valid values:'."\n" ."\n" .'* **200**: success'."\n" .'* **400**: client error'."\n" .'* **500**: server error'."\n", 'type' => 'integer', 'format' => 'int32', 'enumValueTitles' => [], 'example' => '200', ], 'Message' => [ 'description' => 'The response parameters.'."\n", 'type' => 'string', 'example' => 'success', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '224DB9F7-3100-4899-AB9C-C938BCCB43E7', ], 'Success' => [ 'description' => 'Indicates whether the request is successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'enumValueTitles' => [], 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidDBInstanceName.TooMuchItems', 'errorMessage' => 'The number of DB instance Names should be no more than 20.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'WhitelistTemplateRelationToCustinsId.NotFound', 'errorMessage' => 'Whitelist Template relation to CustinsId not found.', ], [ 'errorCode' => 'InsName.NotFound', 'errorMessage' => 'InsName not found.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Data\\": {\\n \\"Status\\": \\"ok\\"\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"224DB9F7-3100-4899-AB9C-C938BCCB43E7\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'DetachWhitelistTemplateToInstance', 'description' => '### Supported database engines'."\n" ."\n" .'* RDS MySQL'."\n" .'* RDS PostgreSQL'."\n" .'* RDS SQL Server'."\n", ], 'ModifyWhitelistTemplate' => [ 'summary' => 'Edits a whitelist. You can call this operation to create, modify, or delete a whitelist.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'IpWhitelist', 'in' => 'query', 'schema' => [ 'title' => '允许访问的IP名单，以逗号隔开，不可重复，最多100个；支持格式：%，0.0.0.0/0，10.23.12.24（IP），或者10.23.12', 'description' => 'The IP addresses in an IP address whitelist. Separate multiple IP addresses with commas (,). Each IP address in the IP address whitelist must be unique. The entries in the IP address whitelist must be in one of the following formats:'."\n" ."\n" .'* IP addresses, such as 10.23.XX.XX.'."\n" .'* CIDR blocks, such as 10.23.XX.XX/24. In this example, 24 indicates that the prefix of the CIDR block is 24-bit in length. You can replace 24 with a value that ranges from 1 to 32.'."\n" ."\n" .'> : A maximum of 1,000 IP addresses or CIDR blocks can be added for each instance. If you want to add a large number of IP addresses, we recommend that you merge them into CIDR blocks, such as 10.23.XX.XX/24.'."\n", 'type' => 'string', 'required' => true, 'example' => '139.196.X.X,101.132.X.X', ], ], [ 'name' => 'TemplateId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the whitelist template. This parameter is required when you modify or delete a whitelist. You can call the DescribeAllWhitelistTemplate operation to obtain the ID of the whitelist.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '539', ], ], [ 'name' => 'TemplateName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the IP whitelist. This parameter is required when you create a whitelist. The value of this parameter cannot be modified after the whitelist is created. The value must be unique to an Alibaba Cloud account and start with a letter. You can call the DescribeWhitelistTemplate operation to obtain the name of the whitelist.'."\n", 'type' => 'string', 'required' => false, 'example' => 'template_123', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the [DescribeRegions](~~26243~~) operation to query the most recent zone list.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'docRequired' => true, ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The resource group ID. For more information about resource groups, see related documentation.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResponse', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Code' => [ 'description' => 'The response code returned. Valid values:'."\n" ."\n" .'* **200**: success'."\n" .'* **400**: client error'."\n" .'* **401**: identity authentication failed'."\n" .'* **404**: request page not found'."\n" .'* **500**: server error'."\n", 'type' => 'string', 'enumValueTitles' => [], 'example' => '200', ], 'Data' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => 'The status code returned. Valid values:'."\n" ."\n" .'* **ok**: The request is successful.'."\n" .'* **error**: The request fails.'."\n", 'type' => 'string', 'enumValueTitles' => [], 'example' => 'ok', ], ], ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code returned. Valid values:'."\n" ."\n" .'* **200**: success'."\n" .'* **400**: client error'."\n" .'* **500**: server error'."\n", 'type' => 'integer', 'format' => 'int32', 'enumValueTitles' => [], 'example' => '200', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '08A3B71B-FE08-4B03-974F-CC7EA6DB1828', ], 'Success' => [ 'description' => 'Indicates whether the request is successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'enumValueTitles' => [], 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidIPList.Format', 'errorMessage' => 'Specified IPList is not valid.', ], [ 'errorCode' => 'InvalidParameter', 'errorMessage' => 'Invalid parameter.', ], [ 'errorCode' => 'InvalidWhitelistTemplateName.Duplicated', 'errorMessage' => 'Whitelist template name duplicated.', ], [ 'errorCode' => 'InvalidSecurityIPList.QuotaExceeded', 'errorMessage' => 'Specified security IP list is not valid: Exceeding the allowed amount of IP address in the list.', ], [ 'errorCode' => 'SecurityIPList.Format', 'errorMessage' => 'Specified SecurityIPList is not valid.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], [ [ 'errorCode' => 'WhitelistIPLength.Forbidden', 'errorMessage' => 'Whitelist ip length exceeeds the limit.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'WhitelistTemplateId.NotFound', 'errorMessage' => 'Whitelist Template id not found.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Data\\": {\\n \\"Status\\": \\"ok\\"\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"08A3B71B-FE08-4B03-974F-CC7EA6DB1828\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'ModifyWhitelistTemplate', 'description' => '### Supported database engines'."\n" ."\n" .'* RDS MySQL'."\n" .'* RDS PostgreSQL'."\n" .'* RDS SQL Server'."\n", ], 'DescribeSecurityGroupConfiguration' => [ 'summary' => 'Queries ECS security groups to which an instance is added.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5xxxxxx', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The details of the response parameters.'."\n", 'type' => 'object', 'properties' => [ 'DBInstanceName' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5xxxxxx', ], 'Items' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'EcsSecurityGroupRelation' => [ 'description' => 'The information about the ECS security group.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'NetworkType' => [ 'description' => 'The network type of the ECS security group. Valid values:'."\n" ."\n" .'* **Classic**'."\n" .'* **VPC**'."\n", 'type' => 'string', 'example' => 'VPC', ], 'RegionId' => [ 'description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], 'SecurityGroupId' => [ 'description' => 'The ID of the ECS security group.'."\n", 'type' => 'string', 'example' => 'sg-xxxxxxx', ], 'SecurityGroupName' => [ 'description' => 'The security group name.'."\n", 'type' => 'string', 'example' => 'security-group-emraccess', ], ], ], ], ], ], 'RequestId' => [ 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '87BDAE8C-xxxx-4A26-BBCC-7D1DD31D630D', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBInstanceName\\": \\"rm-uf6wjk****\\",\\n \\"Items\\": {\\n \\"EcsSecurityGroupRelation\\": [\\n {\\n \\"NetworkType\\": \\"VPC\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"SecurityGroupId\\": \\"sg-****\\",\\n \\"SecurityGroupName\\": \\"security-group-emraccess\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"87BDAE8C-ACB0-4A26-BBCC-7D1DD31D630D\\"\\n}","errorExample":""},{"type":"xml","example":"\\n rm-uf6wjk5xxxxxx\\n 87BDAE8C-ACB0-4A26-BBCC-7D1DD31D630D\\n \\n VPC\\n sg-xxxxxxx\\n cn-hangzhou\\n security-group-emraccess\\n \\n","errorExample":""}]', 'title' => 'DescribeSecurityGroupConfiguration', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" ."\n" .'* PostgreSQL'."\n" ."\n" .'* SQL Server'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.'."\n" ."\n" .'* [Configure a security group for an ApsaraDB RDS for MySQL instance](~~201042~~)'."\n" .'* [Configure a security group for an ApsaraDB RDS for PostgreSQL instance](~~206310~~)'."\n" .'* [Configure a security group for an ApsaraDB RDS for SQL Server instance](~~2392322~~)', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ModifySecurityGroupConfiguration' => [ 'summary' => 'Changes the ECS security groups to which an instance is added.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5xxxxxx', ], ], [ 'name' => 'SecurityGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the ECS security group. Each instance can be added to up to 10 security groups. Separate multiple security groups with commas (,). To delete an ECS security group, leave this parameter empty. You can call the DescribeSecurityGroups operation to query the ID of the ECS security group.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'sg-xxxxxxx', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'DBInstanceName' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5xxxxxx', ], 'Items' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'EcsSecurityGroupRelation' => [ 'description' => 'An array that consists of information about the ECS security group.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'NetworkType' => [ 'description' => 'The network type of the ECS security group. Valid values:'."\n" ."\n" .'* **Classic**'."\n" .'* **VPC**'."\n", 'type' => 'string', 'example' => 'VPC', ], 'RegionId' => [ 'description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], 'SecurityGroupId' => [ 'description' => 'The ID of the ECS security group.'."\n", 'type' => 'string', 'example' => 'sg-xxxxxxx', ], ], ], ], ], ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '8585861B-8F0D-4D17-9460-C42255EB10C0', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'AssociatedEcsSecurityGroupIdQuotaExceed', 'errorMessage' => 'Security groups quota exceeded', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'InvalidEcsSecurityGroupId', 'errorMessage' => 'Specified ecs security group id is not valid.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBInstanceName\\": \\"rm-uf6wjk5****\\",\\n \\"Items\\": {\\n \\"EcsSecurityGroupRelation\\": [\\n {\\n \\"NetworkType\\": \\"VPC\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"SecurityGroupId\\": \\"sg-****\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"8585861B-8F0D-4D17-9460-C42255EB10C0\\"\\n}","errorExample":""},{"type":"xml","example":"\\n\\n \\n VPC\\n sg-1xxxxxxx\\n cn-hangzhou\\n \\n \\n VPC\\n sg-2xxxxxxx\\n cn-hangzhou\\n \\n\\n8585861B-8F0D-4D17-9460-C42255EB10C0\\nrm-uf6wjk5xxxxxx\\n","errorExample":""}]', 'title' => 'ModifySecurityGroupConfiguration', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.'."\n" ."\n" .'* [Configure a security group for an ApsaraDB RDS for MySQL instance](~~201042~~)'."\n" .'* [Configure a security group for an ApsaraDB RDS for PostgreSQL instance](~~206310~~)'."\n" .'* [Configure a security group for an ApsaraDB RDS for SQL Server instance](~~2392322~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'CreateDBInstanceSecurityGroupRule' => [ 'summary' => 'Adds a security group rule to an ApsaraDB RDS for SQL Server instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the instance. You can call the [DescribeDBInstances](~~2628785~~) operation to query the IDs of instances.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-bp15i4hn07r******', ], ], [ 'name' => 'PortRange', 'in' => 'query', 'schema' => [ 'description' => 'The range of destination ports over which TCP and UDP traffic is allowed in the security group rule.'."\n" ."\n" .'Valid values: 1 to 65535. Separate the start port number and the end port number with a forward slash (/). Example: 1/200.'."\n", 'type' => 'string', 'required' => true, 'example' => '1/200', ], ], [ 'name' => 'IpProtocol', 'in' => 'query', 'schema' => [ 'description' => 'The type of the transport layer protocol. Valid values:'."\n" ."\n" .'* TCP'."\n" .'* UDP'."\n", 'type' => 'string', 'required' => false, 'example' => 'TCP', ], ], [ 'name' => 'SourceCidrIp', 'in' => 'query', 'schema' => [ 'description' => 'The range of source IP addresses. CIDR blocks and IPv4 addresses are supported.'."\n", 'type' => 'string', 'required' => false, 'example' => '192.XX.XX.100', ], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => [ 'description' => 'The description of the security group rule.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zht_test', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Code' => [ 'description' => 'The status code returned.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The information about the status code.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '07F6177E-6DE4-408A-BB4F-0723301340F4', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'MissingPortRange', 'errorMessage' => 'The request is missing a portRange parameter.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"07F6177E-6DE4-408A-BB4F-0723301340F4\\"\\n}","type":"json"}]', 'title' => 'CreateDBInstanceSecurityGroupRule', 'description' => '### [](#)Supported database engine'."\n" ."\n" .'SQL Server'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'[Configure security group settings for an ApsaraDB RDS for SQL Server instance](~~2392322~~)'."\n", ], 'DescribeDBInstanceSecurityGroupRule' => [ 'summary' => 'Queries the security group rules that are configured for an ApsaraDB RDS for SQL Server instance.', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the instance. You can call the [DescribeDBInstances](~~2628785~~) operation to query the IDs of instances.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-2ze202******', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Code' => [ 'description' => 'The status code returned.'."\n", 'type' => 'string', 'example' => '200', ], 'Data' => [ 'description' => 'The details of the security group rule.'."\n", 'type' => 'string', 'example' => '{"dbInstanceName": "rm-2ze202\\*\\*\\*\\*\\*\\*", "securityGroup": "{\\\\"description\\\\":\\\\"RDS ONLINE SECURITY\\\\",\\\\"permissions\\\\":\\[{\\\\"rule\\\\":{\\\\"description\\\\":\\\\"SSAS\\\\",\\\\"ipProtocol\\\\":\\\\"TCP\\\\",\\\\"portRange\\\\":\\\\"23\\*\\*/23\\*\\*\\\\",\\\\"sourceCidrIp\\\\":\\\\"0.0.0.0/0\\\\"},\\\\"securityGroupRuleId\\\\":\\\\"sgr-2ze17u\\*\\*\\*\\*\\*\\*\\\\"},{\\\\"rule\\\\":{\\\\"description\\\\":\\\\"test\\\\",\\\\"ipProtocol\\\\":\\\\"TCP\\\\",\\\\"portRange\\\\":\\\\"34/34\\\\",\\\\"sourceCidrIp\\\\":\\\\"42.XXX.XX.247\\\\"},\\\\"securityGroupRuleId\\\\":\\\\"sgr-2ze\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\\\"}],\\\\"regionId\\\\":\\\\"cn-beijing\\\\",\\\\"securityGroupId\\\\":\\\\"sg-2ze0ht\\*\\*\\*\\*\\*\\*\\\\",\\\\"securityGroupName\\\\":\\\\"cn-beijing_msdtc_vpc-2ze\\*\\*\\*\\*\\*\\*\\\\"}"}'."\n", ], 'Message' => [ 'description' => 'The information about the status code.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '6BFF4136-10B9-130B-BF8E-D3504BCE4F43', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Data\\": \\"{\\\\\\"dbInstanceName\\\\\\": \\\\\\"rm-2ze202******\\\\\\",\\\\n\\\\\\"securityGroup\\\\\\": \\\\\\"{\\\\\\\\\\\\\\"description\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"RDS ONLINE SECURITY\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"permissions\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"rule\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"description\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"SSAS\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ipProtocol\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"TCP\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"portRange\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"23**/23**\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"sourceCidrIp\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"0.0.0.0/0\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"securityGroupRuleId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"sgr-2ze17u******\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"rule\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"description\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"测试\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ipProtocol\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"TCP\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"portRange\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"34/34\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"sourceCidrIp\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"42.XXX.XX.247\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"securityGroupRuleId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"sgr-2ze************\\\\\\\\\\\\\\"}],\\\\\\\\\\\\\\"regionId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"cn-beijing\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"securityGroupId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"sg-2ze0ht******\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"securityGroupName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"cn-beijing_msdtc_vpc-2ze******\\\\\\\\\\\\\\"}\\\\\\"}\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"6BFF4136-10B9-130B-BF8E-D3504BCE4F43\\"\\n}","type":"json"}]', 'title' => 'DescribeDBInstanceSecurityGroupRule', 'description' => '### [](#)Supported database engine'."\n" ."\n" .'SQL Server'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'[Configure security group settings for an ApsaraDB RDS for SQL Server instance](~~2392322~~)'."\n", ], 'ModifyDBInstanceSecurityGroupRule' => [ 'summary' => 'Modifies a security group rule that is configured for an ApsaraDB RDS for SQL Server instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the instance. You can call the [DescribeDBInstances](~~2628785~~) operation to query the IDs of instances.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-bp15i4hn07r******', ], ], [ 'name' => 'SecurityGroupRuleId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the security group rule. You can call the [DescribeDBInstanceSecurityGroupRule](~~2834044~~) to obtain the ID of the security group rule.'."\n", 'type' => 'string', 'required' => true, 'example' => 'sgr-2ze17u******', ], ], [ 'name' => 'PortRange', 'in' => 'query', 'schema' => [ 'description' => 'The range of destination ports over which TCP and UDP traffic is allowed in the security group rule.'."\n" ."\n" .'Valid values: 1 to 65535. Separate the start port number and the end port number with a forward slash (/). Example: 1/200.'."\n", 'type' => 'string', 'required' => true, 'example' => '1/200', ], ], [ 'name' => 'IpProtocol', 'in' => 'query', 'schema' => [ 'description' => 'The type of the transport layer protocol. Valid values:'."\n" ."\n" .'* TCP'."\n" .'* UDP'."\n", 'type' => 'string', 'required' => true, 'example' => 'TCP'."\n", ], ], [ 'name' => 'SourceCidrIp', 'in' => 'query', 'schema' => [ 'description' => 'The range of source IP addresses. CIDR blocks and IPv4 addresses are supported.'."\n", 'type' => 'string', 'required' => true, 'example' => '192.XX.XX.100', ], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => [ 'description' => 'The description of the security group rule.'."\n", 'type' => 'string', 'required' => true, 'example' => 'zht_test', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Code' => [ 'description' => 'The status code returned.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The information about the status code.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '07F6177E-6DE4-408A-BB4F-0723301340F7', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"07F6177E-6DE4-408A-BB4F-0723301340F7\\"\\n}","type":"json"}]', 'title' => 'ModifyDBInstanceSecurityGroupRule', 'description' => '### [](#)Supported database engine'."\n" ."\n" .'SQL Server'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'[Configure security group settings for an ApsaraDB RDS for SQL Server instance](~~2392322~~)'."\n", ], 'DeleteDBInstanceSecurityGroupRule' => [ 'summary' => 'Deletes a security group rule that is configured for an ApsaraDB RDS for SQL Server instance.', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the instance. You can call the [DescribeDBInstances](~~2628785~~) operation to query the IDs of instances.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-bp15i4hn07r******', ], ], [ 'name' => 'SecurityGroupRuleIds', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the security group rule. You can call the [DescribeDBInstanceSecurityGroupRule](~~2834044~~) to obtain the ID of the security group rule.'."\n", 'type' => 'string', 'required' => true, 'example' => 'sgr-2ze17u******', ], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOC******', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Code' => [ 'description' => 'The status code returned.'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The information about the status code.'."\n", 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '07F6177E-6DE4-408A-BB4F-0723301340F8', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"07F6177E-6DE4-408A-BB4F-0723301340F8\\"\\n}","type":"json"}]', 'title' => 'DeleteDBInstanceSecurityGroupRule', 'description' => '### [](#)Supported database engine'."\n" ."\n" .'SQL Server'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'[Configure security group settings for an ApsaraDB RDS for SQL Server instance](~~2392322~~)'."\n", ], 'ModifySecurityIps' => [ 'summary' => 'Modifies the IP address whitelist of an ApsaraDB RDS instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pgm-bp18n0c8zt45****', ], ], [ 'name' => 'SecurityIps', 'in' => 'query', 'schema' => [ 'description' => 'The IP addresses in an IP address whitelist. Separate multiple IP addresses with commas (,). Each IP address in the IP address whitelist must be unique. The entries in the IP address whitelist must be in one of the following formats:'."\n" ."\n" .'* IP addresses, such as 10.23.XX.XX.'."\n" .'* CIDR blocks, such as 10.23.XX.XX/24. In this example, 24 indicates that the prefix of each IP address in the IP address whitelist is 24 bits in length. You can replace 24 with a value within the range of 1 to 32.'."\n" ."\n" .'> A maximum of 1,000 IP addresses or CIDR blocks can be added for each instance. If you want to add a large number of IP addresses, we recommend that you merge them into CIDR blocks, such as 10.23.XX.XX/24.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '10.23.XX.XX', ], ], [ 'name' => 'DBInstanceIPArrayName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the IP address whitelist that you want to modify. Default value: **Default**.'."\n" ."\n" .'> A maximum of 200 IP address whitelists can be configured for each instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', ], ], [ 'name' => 'DBInstanceIPArrayAttribute', 'in' => 'query', 'schema' => [ 'description' => 'The attribute of the IP address whitelist. By default, this parameter is empty.'."\n" ."\n" .'> The IP address whitelists that have the hidden attribute are not displayed in the ApsaraDB RDS console. These IP address whitelists are used to access Alibaba Cloud services, such as Data Transmission Service (DTS).'."\n", 'type' => 'string', 'required' => false, 'example' => 'hidden', ], ], [ 'name' => 'SecurityIPType', 'in' => 'query', 'schema' => [ 'description' => 'The IP address type. The value is fixed as IPv4.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'enumValueTitles' => [], 'example' => 'IPv4', 'default' => 'IPv4', 'enum' => [ 'IPv4', 'IPV4', 'Ipv4', 'IpV4', 'iPv4', 'iPV4', 'ipv4', 'ipV4', 'IPv6', 'IPV6', 'Ipv6', 'IpV6', 'iPv6', 'iPV6', 'ipv6', 'ipV6', ], ], ], [ 'name' => 'WhitelistNetworkType', 'in' => 'query', 'schema' => [ 'description' => 'The network type of the IP address whitelist. Valid values:'."\n" ."\n" .'* **Classic**: classic network in enhanced whitelist mode'."\n" .'* **VPC**: virtual private cloud (VPC) network type in enhanced whitelist mode.'."\n" .'* **MIX**: standard whitelist mode'."\n" ."\n" .'Default value: **MIX**.'."\n" ."\n" .'> '."\n" ."\n" .'* In standard whitelist mode, IP addresses and CIDR blocks are added only to the default IP address whitelist. In enhanced whitelist mode, IP addresses and CIDR blocks are added to the IP address whitelists of the classic network type and the VPC network type.'."\n" ."\n" .'* If your RDS instance runs PostgreSQL and uses cloud disks, set this parameter to MIX. If you set it to another value, the system automatically changes the value to MIX.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Classic', ], ], [ 'name' => 'ModifyMode', 'in' => 'query', 'schema' => [ 'description' => 'The method that is used to modify the whitelist. Valid values:'."\n" ."\n" .'* **Cover**: Use the IP addresses and CIDR blocks that are specified in the **SecurityIps** parameter to overwrite the existing IP addresses and CIDR blocks in the IP address whitelist.'."\n" .'* **Append**: Add the IP addresses and CIDR blocks that are specified in the **SecurityIps** parameter to the IP address whitelist.'."\n" .'* **Delete**: Delete the IP addresses and CIDR blocks that are specified in the **SecurityIps** parameter from the IP address whitelist. You must retain at least one IP address or CIDR block.'."\n" ."\n" .'Default value: **Cover**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Cover', 'default' => '0', ], ], [ 'name' => 'FreshWhiteListReadins', 'in' => 'query', 'schema' => [ 'description' => 'The read-only instances to which you want to synchronize the IP address whitelist.'."\n" ."\n" .'* This parameter applies only to ApsaraDB RDS for PostgreSQL instances.'."\n" .'* If the instance is attached with a read-only instance, you can use this parameter to synchronize the IP address whitelist to the read-only instance. If the instance is attached with multiple read-only instances, separate the read-only instances with commas (,).'."\n" .'* If the instance is not attached with a read-only instance, leave this parameter empty.'."\n", 'type' => 'string', 'required' => false, 'example' => 'pgr-bp17yuz4dn3d****,pgr-bp1vn2ph54u1****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => ' 1AD222E9-E606-4A42-BF6D-8A4442913CEF', ], 'TaskId' => [ 'description' => 'The task ID.'."\n", 'type' => 'string', 'example' => '115855279', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'IncorrectMasterDBInstanceState', 'errorMessage' => 'Master instance state does not support this operation.', ], [ 'errorCode' => 'InvalidWhitelistNetType.Malformed', 'errorMessage' => 'Specified WhitelistNetType is not valid.', ], [ 'errorCode' => 'InvalidIPArrayAttribute.Format', 'errorMessage' => 'The format of the IP attribute is invalid.', ], [ 'errorCode' => 'InvalidSecurityIPList.Duplicate', 'errorMessage' => 'Specified security IP list is not valid: Duplicate IP address in the list.', ], [ 'errorCode' => 'SecurityIPList.Format', 'errorMessage' => 'Specified SecurityIPList is not valid.', ], [ 'errorCode' => 'InvalidGroupName.DuplicatedWithTemplate', 'errorMessage' => 'Sepecified group name is used by whitelist template.', ], [ 'errorCode' => 'InvalidSecurityIPListGroup.QuotaExceeded', 'errorMessage' => 'Specified security IP list group is not valid: Exceeding the allowed amount of group.', ], [ 'errorCode' => 'InvalidDBInstanceType.Format', 'errorMessage' => 'Specified instance type is not valid.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'IncorrectDBType', 'errorMessage' => 'The current DB type does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstanceCharacterType', 'errorMessage' => 'Current DB Instance character_type does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', ], [ 'errorCode' => 'IncorrectEngineVersion', 'errorMessage' => 'The engine version does not support the operation.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'Readins.NotFound', 'errorMessage' => 'The current instance does not contain any read only instance. The operation is not supported.', ], [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', ], [ 'errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance does not exist or is not supported.', ], [ 'errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\" 1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"TaskId\\": \\"11585****\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"7463B73D-35CC-4D19-A010-6B8D65D242EF\\",\\n \\"HostId\\": \\"rds.aliyuncs.com\\",\\n \\"Code\\": \\"UnsupportedOperation\\",\\n \\"Message\\": \\"The specified action is not supported.\\"\\n}"},{"type":"xml","example":"\\n\\t 1AD222E9-E606-4A42-BF6D-8A4442913CEF\\n\\t115855279\\n\\n\\t","errorExample":""}]', 'title' => 'ModifySecurityIps', 'description' => '### Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" .'* MariaDB'."\n" ."\n" .'### References'."\n" ."\n" .'> Before you call this operation, read the following documentation and make sure that you fully understand the prerequisites and impacts of this operation.'."\n" ."\n" .'* [Configure an IP address whitelist for an ApsaraDB RDS for MySQL instance](~~96118~~)'."\n" .'* [Configure an IP address whitelist for an ApsaraDB RDS for PostgreSQL instance](~~43187~~)'."\n" .'* [Configure an IP address whitelist for an ApsaraDB RDS for SQL Server instance](~~43186~~)'."\n" .'* [Configure an IP address whitelist for an ApsaraDB RDS for MariaDB instance](~~90336~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ModifyDBInstanceSSL' => [ 'summary' => 'Modifies the SSL encryption settings of an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5xxxxxxx', ], ], [ 'name' => 'ConnectionString', 'in' => 'query', 'schema' => [ 'description' => 'The internal or public endpoint for which the server certificate needs to be created or updated.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5xxxxx.mysql.rds.aliyuncs.com', ], ], [ 'name' => 'SSLEnabled', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable or disable the SSL encryption feature. Valid values:'."\n" ."\n" .'* **1**: enables the feature.'."\n" .'* **0**: disables the feature.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'CAType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the server certificate. This parameter is supported only when the instance runs MySQL or PostgreSQL with cloud disks. If you set SSLEnabled to **1**, the default value of this parameter is **aliyun**. Valid values:'."\n" ."\n" .'* **aliyun**: a cloud certificate'."\n" .'* **custom**: a custom certificate'."\n", 'type' => 'string', 'required' => false, 'example' => 'aliyun', ], ], [ 'name' => 'ServerCert', 'in' => 'query', 'schema' => [ 'description' => 'The content of the server certificate. This parameter is supported only when the instance runs PostgreSQL with cloud disks. This parameter must be specified when CAType is set to **custom**.'."\n", 'type' => 'string', 'required' => false, 'example' => '-----BEGIN CERTIFICATE-----MIID*****QqEP-----END CERTIFICATE-----', ], ], [ 'name' => 'ServerKey', 'in' => 'query', 'schema' => [ 'description' => 'The private key of the server certificate. This parameter is supported only when the instance runs PostgreSQL with cloud disks. This parameter must be specified when CAType is set to **custom**.'."\n", 'type' => 'string', 'required' => false, 'example' => '-----BEGIN PRIVATE KEY-----MIIE****ihfg==-----END PRIVATE KEY-----', ], ], [ 'name' => 'ClientCAEnabled', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable the public key of the CA that issues client certificates. This parameter is supported only when the instance runs PostgreSQL with cloud disks. Valid values:'."\n" ."\n" .'* **1**: enables the public key.'."\n" .'* **0**: disables the public key.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'ClientCACert', 'in' => 'query', 'schema' => [ 'description' => 'The public key of the CA that issues client certificates. This parameter is supported only when the instance runs PostgreSQL with cloud disks. This parameter must be specified when ClientCAEbabled is set to **1**.'."\n", 'type' => 'string', 'required' => false, 'example' => '-----BEGIN CERTIFICATE-----MIID*****viXk=-----END CERTIFICATE-----', ], ], [ 'name' => 'ClientCrlEnabled', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable a certificate revocation list (CRL) that contains revoked client certificates. This parameter is supported only when the instance runs PostgreSQL with cloud disks. In addition, this parameter is available only when the public key of the CA that issues client certificates is enabled. Valid values:'."\n" ."\n" .'* **1**: enables the CRL.'."\n" .'* **0**: disables the CRL.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'ClientCertRevocationList', 'in' => 'query', 'schema' => [ 'description' => 'The CRL that contains revoked client certificates. This parameter is supported only when the instance runs PostgreSQL with cloud disks. This parameter must be specified when ClientCrlEnabled is set to **1**.'."\n", 'type' => 'string', 'required' => false, 'example' => '-----BEGIN X509 CRL-----MIIB****19mg==-----END X509 CRL-----', ], ], [ 'name' => 'ACL', 'in' => 'query', 'schema' => [ 'description' => 'The method that is used to verify the identities of clients. This parameter is supported only when the instance runs PostgreSQL with cloud disks. In addition, this parameter is available only when the public key of the CA that issues client certificates is enabled. Valid values:'."\n" ."\n" .'* **cert**'."\n" .'* **prefer**'."\n" .'* **verify-ca**'."\n" .'* **verify-full** (supported only when the instance runs PostgreSQL 12 or later)'."\n", 'type' => 'string', 'required' => false, 'example' => 'cert', ], ], [ 'name' => 'ReplicationACL', 'in' => 'query', 'schema' => [ 'description' => 'The method that is used to verify the replication permission. This parameter is supported only when the instance runs PostgreSQL with cloud disks. In addition, this parameter is available only when the public key of the CA that issues client certificates is enabled. Valid values:'."\n" ."\n" .'* **cert**'."\n" .'* **prefer**'."\n" .'* **verify-ca**'."\n" .'* **verify-full** (supported only when the instance runs PostgreSQL 12 or later)'."\n", 'type' => 'string', 'required' => false, 'example' => 'cert', ], ], [ 'name' => 'ForceEncryption', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable the forceful SSL encryption feature. This parameter is supported only for ApsaraDB RDS for SQL Server instances. For more information, see [Configure the SSL encryption feature](~~95715~~). Valid values:'."\n" ."\n" .'* **1**: enables the feature.'."\n" .'* **0**: disables the feature.'."\n", 'type' => 'string', 'required' => false, 'example' => '1', ], ], [ 'name' => 'TlsVersion', 'in' => 'query', 'schema' => [ 'description' => 'The minimum Transport Layer Security (TLS) version. Valid values: 1.0, 1.1, and 1.2. This parameter is supported only for ApsaraDB RDS for SQL Server instances. For more information, see [Configure the SSL encryption feature](~~95715~~).'."\n", 'type' => 'string', 'required' => false, 'example' => '1.1', ], ], [ 'name' => 'Certificate', 'in' => 'query', 'schema' => [ 'description' => 'The custom certificate. The custom certificate is in the `PFX` format.'."\n" ."\n" .'* Public endpoint: `oss-.aliyuncs.com::`'."\n" .'* Internal endpoint: `oss--internal.aliyuncs.com::`'."\n", 'type' => 'string', 'required' => false, 'example' => 'oss-cn-beijing-internal.aliyuncs.com:zhttest:test.pfx', ], ], [ 'name' => 'PassWord', 'in' => 'query', 'schema' => [ 'description' => 'The password of the certificate.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zht123456', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '777C4593-8053-427B-99E2-105593277CAB', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidServerCertOrPrivateKey', 'errorMessage' => 'Specify server certificate or private key is invalid.', ], [ 'errorCode' => 'InvalidClientCACert', 'errorMessage' => 'Specify client ca certificate is invalid.', ], [ 'errorCode' => 'InvalidClientCrl', 'errorMessage' => 'Specify client certificate revocation list is invalid.', ], [ 'errorCode' => 'InvalidCAType.NotFound', 'errorMessage' => 'Specify ca type is not found.', ], [ 'errorCode' => 'InvalidACL.NotFound', 'errorMessage' => 'Specify acl is not found.', ], [ 'errorCode' => 'InvalidSSLStatus', 'errorMessage' => 'Specify ssl status is invalid.', ], [ 'errorCode' => 'IncorrectDBSslStatus', 'errorMessage' => 'Specified DB SSLStatus does not support this operation.', ], [ 'errorCode' => 'InvalidModifyMode.Format', 'errorMessage' => 'Specified modify mode is not valid.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'MinorVersionNotSupport.SSLEnabled', 'errorMessage' => 'Custins minor version does not support current action.', ], ], 403 => [ [ 'errorCode' => 'InvalidClientCrl.Permission', 'errorMessage' => 'Client ca certificate is set first if need to set client certificate revocation list.', ], [ 'errorCode' => 'InvalidACL.Permission', 'errorMessage' => 'Client ca certificate is set first if need to set acl.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], [ 'errorCode' => 'MaxscaleMinorVersionNotSupport', 'errorMessage' => 'The Maxscale version used by the instance is too low, please upgrade the Maxscale version first.', ], [ 'errorCode' => 'UnsupportedByBlueGreenDeployment', 'errorMessage' => 'Operation prohibited due to blue green deployment.', ], ], [ [ 'errorCode' => 'Endpoint.NotFound', 'errorMessage' => 'Specified endpoint is not existed.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"777C4593-8053-427B-99E2-105593277CAB\\"\\n}","errorExample":""},{"type":"xml","example":"777C4593-8053-427B-99E2-105593277CAB","errorExample":""}]', 'title' => 'ModifyDBInstanceSSL', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> Before you call this operation, read the following documentation and make sure that you fully understand the prerequisites and impacts of this operation.'."\n" ."\n" .'* [Use the SSL encryption feature for an ApsaraDB RDS for MySQL instance](~~96120~~)'."\n" .'* [Use the SSL encryption feature for an ApsaraDB RDS for PostgreSQL instance](~~229517~~)'."\n" .'* [Use the SSL encryption feature for an ApsaraDB RDS for SQL Server instance](~~95715~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ModifyDBInstanceTDE' => [ 'summary' => 'Enables the Transparent Data Encryption (TDE) feature for an ApsaraDB RDS instance and modifies the TDE status for the instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5****', ], ], [ 'name' => 'TDEStatus', 'in' => 'query', 'schema' => [ 'description' => 'The status of TDE. Valid values:'."\n" ."\n" .'* **Enabled**'."\n" .'* **Disabled**'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Enabled', ], ], [ 'name' => 'DBName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the database for which you want to enable TDE. You can specify up to 50 database names in a single request. If you specify multiple database names, separate the database names with commas (,).'."\n" ."\n" .'> This parameter is available and must be specified only when the instance runs SQL Server 2019 SE or an Enterprise Edition of SQL Server.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testDB', ], ], [ 'name' => 'EncryptionKey', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the custom key.'."\n" ."\n" .'> This parameter is available when the instance runs MySQL or PostgreSQL.'."\n", 'type' => 'string', 'required' => false, 'example' => '749c1df7-****-****-****-****', ], ], [ 'name' => 'RoleArn', 'in' => 'query', 'schema' => [ 'description' => 'The Alibaba Cloud Resource Name (ARN) of the RAM role. A RAM role is a virtual identity that you can create within your Alibaba Cloud account. For more information, see [RAM role overview](~~93689~~).'."\n" ."\n" .'> This parameter is available when the instance runs MySQL or PostgreSQL.'."\n", 'type' => 'string', 'required' => false, 'example' => 'acs:ram::1406926****:role/aliyunrdsinstanceencryptiondefaultrole', ], ], [ 'name' => 'Certificate', 'in' => 'query', 'schema' => [ 'description' => 'The file that contains the certificate.\\'."\n" .'Format:'."\n" ."\n" .'* Public endpoint: `oss-.aliyuncs.com::` (The file name contains the extension.)'."\n" .'* Internal endpoint: `oss--internal.aliyuncs.com::` (The file name contains the extension.)'."\n" ."\n" .'> * This parameter is available when the instance runs SQL Server 2019 SE or an Enterprise Edition of SQL Server.'."\n" .'> * You can call the [DescribeRegions](~~26243~~) operation to query the most recent region list.', 'type' => 'string', 'required' => false, 'example' => 'oss-ap-southeast-1.aliyuncs.com:****:key.cer', ], ], [ 'name' => 'PrivateKey', 'in' => 'query', 'schema' => [ 'description' => 'The file that contains the private key of the certificate.\\'."\n" .'Format:'."\n" ."\n" .'* Public endpoint: `oss-.aliyuncs.com::` (The file name contains the extension.)'."\n" .'* Internal endpoint: `oss--internal.aliyuncs.com::` (The file name contains the extension.)'."\n" ."\n" .'> * This parameter is available when the instance runs SQL Server 2019 SE or an Enterprise Edition of SQL Server.'."\n" .'> * You can call the [DescribeRegions](~~26243~~) operation to query the most recent region list.', 'type' => 'string', 'required' => false, 'example' => 'oss-ap-southeast-1.aliyuncs.com:****:key.pvk', ], ], [ 'name' => 'PassWord', 'in' => 'query', 'schema' => [ 'description' => 'The password of the certificate.'."\n" ."\n" .'> This parameter is available when the instance runs SQL Server 2019 SE or an Enterprise Edition of SQL Server.'."\n", 'type' => 'string', 'required' => false, 'example' => '1qaz@WSX', ], ], [ 'name' => 'IsRotate', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to replace the key. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false** (default)'."\n" ."\n" .'> This parameter is available for only ApsaraDB RDS for PostgreSQL instances.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '777C4593-8053-427B-99E2-105593277CAB', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => '%s', 'errorMessage' => 'DB Operation Failed:%s.', ], [ 'errorCode' => 'InvalidTDEstatus', 'errorMessage' => 'Specified TDEStatus has already configed in the This instance.', ], [ 'errorCode' => 'MissingDBName', 'errorMessage' => 'The request is missing a DBName parameter.', ], [ 'errorCode' => 'InvalidTDEstatus.Format', 'errorMessage' => 'The Specified TDEStatus is not valid.', ], [ 'errorCode' => 'Invalid.PrivateKey', 'errorMessage' => 'The requested privateKey parameter is invalid.', ], [ 'errorCode' => 'Invalid.Certificate', 'errorMessage' => 'The requested certificate parameter is invalid.', ], [ 'errorCode' => 'CertOrPrivateKeyOrPasswordNotMatched', 'errorMessage' => 'The public certificate, private key, and password do not match.', ], [ 'errorCode' => 'InvalidTDEKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidTDEStatus.NotFound', 'errorMessage' => 'The specified TDEStatus does not exist.', ], [ 'errorCode' => 'PermissionDenied', 'errorMessage' => 'The current account has not been authorized to allow RDS to access user\'s KMS services, authorization needs to be granted to this account.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'BYOKCertExpired', 'errorMessage' => 'The certificate has exceeded the validity period.', ], ], 403 => [ [ 'errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', ], [ 'errorCode' => 'IncorrectEngineVersion', 'errorMessage' => 'Current engine version does not support operations.', ], [ 'errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', ], [ 'errorCode' => 'DBSizeExceeded', 'errorMessage' => 'Exceeding the allowed DB size of DB instance.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'ByokRoleArnNotFound', 'errorMessage' => 'The roleArn can not be null.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], [ 'errorCode' => 'UnsupportedByBlueGreenDeployment', 'errorMessage' => 'Operation prohibited due to blue green deployment.', ], [ 'errorCode' => 'CrossBackupStrategyNotSupport', 'errorMessage' => 'Cross region backup strategy is not supported.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'this cluster not kms service.', ], [ 'errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is insufficient capacity available for the requested instance.', ], [ 'errorCode' => 'InvalidDBName.NotFound', 'errorMessage' => 'Specified one or more DB name does not exist or DB status does not support.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"777C4593-8053-427B-99E2-105593277CAB\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 777C4593-8053-427B-99E2-105593277CAB\\n","errorExample":""}]', 'title' => 'ModifyDBInstanceTDE', 'description' => '### Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" ."\n" .'### References'."\n" ."\n" .'> Before you call this operation, read the following documentation and make sure that you fully understand the prerequisites and impacts of this operation.'."\n" ."\n" .'* [Configure TDE for an ApsaraDB RDS for MySQL instance](~~96121~~)'."\n" .'* [Configure TDE for an ApsaraDB RDS for PostgreSQL instance](~~465652~~)'."\n" .'* [Configure TDE for an ApsaraDB RDS for SQL Server instance](~~95716~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ModifyDTCSecurityIpHostsForSQLServer' => [ 'summary' => 'Configures a distributed transaction whitelist for an ApsaraDB RDS for SQL Server instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5xxxxxxx', ], ], [ 'name' => 'SecurityIpHosts', 'in' => 'query', 'schema' => [ 'description' => 'The IP address of the ECS instance and the hostname of the Windows computer. Format: `IP address,Hostname`. Separate multiple entries with semicolon (;).'."\n" ."\n" .'> For more information about how to query the computer hostname, see [Configure a distributed transaction whitelist](~~124321~~).'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '192.168.1.100,k3ecstest', ], ], [ 'name' => 'WhiteListGroupName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the IP address whitelist.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test1', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'DBInstanceId' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5xxxxxxx', ], 'DTCSetResult' => [ 'description' => 'The result of the IP address whitelist configuration. Valid values:'."\n" ."\n" .'* **Success**'."\n" .'* **Fail**'."\n", 'type' => 'string', 'example' => 'Success', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '671B6D32-B907-4EFF-A3B7-94D2EAD5E3A3', ], 'TaskId' => [ 'description' => 'The task ID.'."\n", 'type' => 'string', 'example' => '178968983', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBInstanceId\\": \\"rm-uf6wjk5****\\",\\n \\"DTCSetResult\\": \\"Success\\",\\n \\"RequestId\\": \\"671B6D32-B907-4EFF-A3B7-94D2EAD5E3A3\\",\\n \\"TaskId\\": \\"178968983\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n671B6D32-B907-4EFF-A3B7-94D2EAD5E3A3\\r\\n\\trm-uf6wjk5xxxxxxx\\r\\n\\tSuccess\\r\\n\\t178968983\\r\\n","errorExample":""}]', 'title' => 'ModifyDTCSecurityIpHostsForSQLServer', 'description' => '### [](#)Supported database engine'."\n" ."\n" .'SQL Server'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.'."\n" ."\n" .'[Configure a distributed transaction whitelist](~~124321~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ModifyDBInstanceDeletionProtection' => [ 'summary' => 'Enable or disable the release protection feature for an instance.', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the generated token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxxxxx', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5xxxxxxx', ], ], [ 'name' => 'DeletionProtection', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable the release protection feature for the read-only instance. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'true', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '3C5CFDEE-F774-4DED-89A2-1D76EC63C575', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'OperationDenied.PayType', 'errorMessage' => 'The operation is not permitted due to pay type of instance.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"3C5CFDEE-F774-4DED-89A2-1D76EC63C575\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 3C5CFDEE-F774-4DED-89A2-1D76EC63C575\\n","errorExample":""}]', 'title' => 'ModifyDBInstanceDeletionProtection', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" .'* MariaDB'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> : Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.'."\n" ."\n" .'* [Enable and disable instance release protection for an ApsaraDB RDS for MySQL instance](~~414512~~)'."\n" .'* [Enable and disable instance release protection for an ApsaraDB RDS for PostgreSQL instance](~~471512~~)'."\n" .'* [Enable and disable instance release protection for an ApsaraDB RDS for SQL Server instance](~~416209~~)'."\n" .'* [Enable and disable release protection for an ApsaraDB RDS for MariaDB instance](~~414512~~)'."\n", ], 'DescribeWhitelistTemplateLinkedInstance' => [ 'summary' => 'Queries associated instances by whitelist template.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'TemplateId', 'in' => 'formData', 'schema' => [ 'description' => 'The ID of the whitelist template. You can call the DescribeAllWhitelistTemplate operation to obtain the ID of the whitelist template.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '412', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The resource group ID. You can leave this parameter empty.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy*****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResponse', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Code' => [ 'description' => 'The response code returned. Valid values:'."\n" ."\n" .'* **200**: success'."\n" .'* **400**: client error'."\n" .'* **401**: identity authentication failed'."\n" .'* **404**: request page not found'."\n" .'* **500**: server error'."\n", 'type' => 'string', 'enumValueTitles' => [], 'example' => '200', ], 'Data' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'InsName' => [ 'description' => 'The information about the instance.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-2zer90r262lp0****', ], ], 'TemplateId' => [ 'description' => 'The ID of the whitelist template.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '412', ], ], ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code returned. Valid values:'."\n" ."\n" .'* **200**: success'."\n" .'* **400**: client error'."\n" .'* **500**: server error'."\n", 'type' => 'integer', 'format' => 'int32', 'enumValueTitles' => [], 'example' => '200', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'Successful', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '9F8C06AD-3F37-57A0-ABBF-ABD7824F55CE', ], 'Success' => [ 'description' => 'Indicates whether the request is successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'enumValueTitles' => [], 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'WhitelistTemplateId.NotFound', 'errorMessage' => 'Whitelist Template id not found.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Data\\": {\\n \\"InsName\\": [\\n \\"rm-2zer90r262lp0****\\"\\n ],\\n \\"TemplateId\\": 412\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"9F8C06AD-3F37-57A0-ABBF-ABD7824F55CE\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'DescribeWhitelistTemplateLinkedInstance', 'description' => '### Supported database engines'."\n" ."\n" .'* RDS MySQL'."\n" .'* RDS PostgreSQL'."\n" .'* RDS SQL Server'."\n", ], 'DescribeInstanceLinkedWhitelistTemplate' => [ 'summary' => 'Queries associated whitelists by instance name.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'InsName', 'in' => 'query', 'schema' => [ 'description' => 'The instance name.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-bp191w771kd3****', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the DescribeRegions operation to query the most recent region list.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The resource group ID. You can leave this parameter empty.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-aek3dbzqbh6****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResponse', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Code' => [ 'description' => 'The response code returned. Valid values:'."\n" ."\n" .'* **200**: success'."\n" .'* **400**: client error'."\n" .'* **401**: identity authentication failed'."\n" .'* **404**: request page not found'."\n" .'* **500**: server error'."\n", 'type' => 'string', 'enumValueTitles' => [], 'example' => '200', ], 'Data' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'InsName' => [ 'description' => 'The instance name.'."\n", 'type' => 'string', 'example' => 'rm-bp191w771kd3****', ], 'Templates' => [ 'description' => 'The information about whitelists that are returned by page.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => 'The primary key of the data table.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1884', ], 'Ips' => [ 'description' => 'The IP addresses.'."\n", 'type' => 'string', 'example' => '12.0.X.X,10.2.X.X', ], 'TemplateId' => [ 'description' => 'The whitelist template ID.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '412', ], 'TemplateName' => [ 'description' => 'The whitelist template name.'."\n", 'type' => 'string', 'example' => 'template_123', ], 'UserId' => [ 'description' => 'The user ID.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '16****', ], ], ], ], ], ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code returned. Valid values:'."\n" ."\n" .'* **200**: success'."\n" .'* **400**: client error'."\n" .'* **500**: server error'."\n", 'type' => 'integer', 'format' => 'int32', 'enumValueTitles' => [], 'example' => '200', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'Successful', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC', ], 'Success' => [ 'description' => 'Indicates whether the request is successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'enumValueTitles' => [], 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InsName.NotFound', 'errorMessage' => 'InsName not found.', ], [ 'errorCode' => 'InvalidUserId.NotSupport', 'errorMessage' => 'The user ID has no permission.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'WhitelistTemplateId.NotFound', 'errorMessage' => 'Whitelist Template id not found.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Data\\": {\\n \\"InsName\\": \\"rm-bp191w771k******\\",\\n \\"Templates\\": [\\n {\\n \\"Id\\": 1884,\\n \\"Ips\\": \\"12.0.X.X,10.2.X.X\\",\\n \\"TemplateId\\": 412,\\n \\"TemplateName\\": \\"template_123\\",\\n \\"UserId\\": 0\\n }\\n ]\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'DescribeInstanceLinkedWhitelistTemplate', 'description' => '### Supported database engines'."\n" ."\n" .'* RDS MySQL'."\n" .'* RDS PostgreSQL'."\n" .'* RDS SQL Server'."\n", ], 'DescribeWhitelistTemplate' => [ 'summary' => 'Queries information about the specified IP whitelist.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'TemplateId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the whitelist template. You can call the [DescribeAllWhitelistTemplate](~~2412075~~) operation to obtain the ID of the whitelist template.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1012', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy****', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the [DescribeRegions](~~26243~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResponse', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Code' => [ 'description' => 'The response code returned. Valid values:'."\n" ."\n" .'* **200**: success'."\n" .'* **400**: client error'."\n" .'* **401**: identity authentication failed'."\n" .'* **404**: request page not found'."\n" .'* **500**: server error'."\n", 'type' => 'string', 'enumValueTitles' => [], 'example' => '200', ], 'Data' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'Template' => [ 'description' => 'The information about the IP whitelist template.'."\n", 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => 'The primary key of the data table.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1013', ], 'Ips' => [ 'description' => 'The IP addresses.'."\n", 'type' => 'string', 'example' => '10.1.X.X,2.3.X.X', ], 'TemplateId' => [ 'description' => 'The ID of the whitelist template.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '424', ], 'TemplateName' => [ 'description' => 'The name of the IP whitelist template.'."\n", 'type' => 'string', 'example' => 'template_123', ], 'UserId' => [ 'description' => 'The user ID.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '16****', ], ], ], ], ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code returned. Valid values:'."\n" ."\n" .'* **200**: success'."\n" .'* **400**: client error'."\n" .'* **500**: server error'."\n", 'type' => 'integer', 'format' => 'int32', 'enumValueTitles' => [], 'example' => '200', ], 'Message' => [ 'description' => 'The response parameters.'."\n", 'type' => 'string', 'example' => 'success', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'ED169A3E-1657-4104-82AB-24EA8CD0DB75', ], 'Success' => [ 'description' => 'Indicates whether the request is successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'enumValueTitles' => [], 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidParameterTemplateId', 'errorMessage' => 'The parameter templateId is invalid.', ], [ 'errorCode' => 'WhitelistTemplateId.NotFound', 'errorMessage' => 'Whitelist Template id not found.', ], [ 'errorCode' => 'InvalidUserId.NotSupport', 'errorMessage' => 'The user ID has no permission.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Data\\": {\\n \\"Template\\": {\\n \\"Id\\": 1013,\\n \\"Ips\\": \\"10.1.X.X,2.3.X.X\\",\\n \\"TemplateId\\": 424,\\n \\"TemplateName\\": \\"template_123\\",\\n \\"UserId\\": 0\\n }\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"ED169A3E-1657-4104-82AB-24EA8CD0DB75\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'DescribeWhitelistTemplate', 'description' => '### Supported database engines'."\n" ."\n" .'* RDS MySQL'."\n" .'* RDS PostgreSQL'."\n" .'* RDS SQL Server'."\n", ], 'DescribeAllWhitelistTemplate' => [ 'summary' => 'Queries whitelist templates at a time by using fuzzy search.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'MaxRecordsPerPage', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Enumerated valid values: 10, 30, and 50.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'enumValueTitles' => [], 'example' => '10', ], ], [ 'name' => 'PageNumbers', 'in' => 'query', 'schema' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'TemplateName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the IP whitelist template. If you specify this parameter when you perform a fuzzy search, you can call the DescribeWhitelistTemplate operation to query the name of the whitelist template during the fuzzy search.'."\n", 'type' => 'string', 'required' => false, 'example' => 'template', ], ], [ 'name' => 'FuzzySearch', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable fuzzy search. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'required' => false, 'enumValueTitles' => [], 'example' => 'true', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The resource group ID. For more information about resource groups, see related documentation.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmyhigxskzysy', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PlainResponse', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Code' => [ 'description' => 'The response code returned. Valid values:'."\n" ."\n" .'* **200**: success'."\n" .'* **400**: client error'."\n" .'* **401**: identity authentication failed'."\n" .'* **404**: request page not found'."\n" .'* **500**: server error'."\n", 'type' => 'string', 'enumValueTitles' => [], 'example' => '200', ], 'Data' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'CurrPageNumbers' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'HasNext' => [ 'description' => 'Indicates whether the data that meets the conditions is displayed on the next page. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'enumValueTitles' => [], 'example' => 'true', ], 'HasPrev' => [ 'description' => 'Indicates whether the data that meets the conditions is displayed on the previous page. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'enumValueTitles' => [], 'example' => 'false', ], 'MaxRecordsPerPage' => [ 'description' => 'The number of entries to return on each page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'Templates' => [ 'description' => 'The information about whitelist templates that are returned by page.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => 'The primary key of the data table.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '123', ], 'Ips' => [ 'description' => 'The IP addresses.'."\n", 'type' => 'string', 'example' => '12.2.X.X,10.0.X.X', ], 'TemplateId' => [ 'description' => 'The ID of the whitelist template.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '412', ], 'TemplateName' => [ 'description' => 'The name of the whitelist template.'."\n", 'type' => 'string', 'example' => 'template_123', ], 'UserId' => [ 'description' => 'The user ID.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '168****', ], ], ], ], 'TotalPageNumbers' => [ 'description' => 'The total number of pages returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'TotalRecords' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '402', ], ], ], 'HttpStatusCode' => [ 'description' => 'The HTTP status code returned. Valid values:'."\n" ."\n" .'* **200**: success'."\n" .'* **400**: client error'."\n" .'* **500**: server error'."\n", 'type' => 'integer', 'format' => 'int32', 'enumValueTitles' => [], 'example' => '200', ], 'Message' => [ 'description' => 'The response parameters.'."\n", 'type' => 'string', 'example' => 'success', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '16C62438-491B-5C02-9B49-BA924A1372A2', ], 'Success' => [ 'description' => 'Indicates whether the request is successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'enumValueTitles' => [], 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidParameterPaging', 'errorMessage' => 'The parameter maxRecordsPerPage or PageNumbers is invalid.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Data\\": {\\n \\"CurrPageNumbers\\": 1,\\n \\"HasNext\\": true,\\n \\"HasPrev\\": false,\\n \\"MaxRecordsPerPage\\": 10,\\n \\"Templates\\": [\\n {\\n \\"Id\\": 123,\\n \\"Ips\\": \\"12.2.X.X,10.0.X.X\\",\\n \\"TemplateId\\": 412,\\n \\"TemplateName\\": \\"template_123\\",\\n \\"UserId\\": 0\\n }\\n ],\\n \\"TotalPageNumbers\\": 3,\\n \\"TotalRecords\\": 402\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"16C62438-491B-5C02-9B49-BA924A1372A2\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'DescribeAllWhitelistTemplate', 'description' => '### Supported database engines'."\n" ."\n" .'* RDS MySQL'."\n" .'* RDS PostgreSQL'."\n" .'* RDS SQL Server'."\n", ], 'DescribeDBInstanceIPArrayList' => [ 'summary' => 'Queries the IP address whitelist of an ApsaraDB RDS instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5xxxxxxx', ], ], [ 'name' => 'WhitelistNetworkType', 'in' => 'query', 'schema' => [ 'description' => 'The network type of the IP address whitelist. Valid values:'."\n" ."\n" .'* **Classic**: classic network in enhanced whitelist mode'."\n" .'* **VPC**: virtual private cloud (VPC) in enhanced whitelist mode'."\n" .'* **MIX**: standard whitelist mode'."\n" ."\n" .'By default, this operation returns IP address whitelists of all network types.'."\n", 'type' => 'string', 'required' => false, 'example' => 'VPC', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Items' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'DBInstanceIPArray' => [ 'description' => 'An array that consists of the details about the IP address whitelists.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'DBInstanceIPArrayAttribute' => [ 'description' => 'The attribute of the IP address whitelist. By default, this parameter is empty.'."\n" ."\n" .'> A whitelist with the hidden attribute does not appear in the console. Such IP address whitelists are used to access Alibaba Cloud services, such as Data Transmission Service (DTS).'."\n", 'type' => 'string', 'example' => 'hidden', ], 'DBInstanceIPArrayName' => [ 'description' => 'The name of the IP address whitelist.'."\n", 'type' => 'string', 'example' => 'rds_default', ], 'SecurityIPList' => [ 'description' => 'The IP addresses in the IP address whitelist.'."\n", 'type' => 'string', 'example' => '192.168.1.0/24', ], 'SecurityIPType' => [ 'description' => 'The type of the IP address.'."\n", 'type' => 'string', 'example' => 'IPv4', ], ], ], ], ], ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'E2B6AF71-DC32-4055-B477-43B348798D10', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidEndpointType.Format', 'errorMessage' => 'The specified EndpointType is invalid.', ], [ 'errorCode' => 'InvalidParameter', 'errorMessage' => 'Invalid parameter.', ], [ 'errorCode' => 'InvalidParameter.OwnerAccount', 'errorMessage' => 'The specified OwnerAccount is invalid.', ], [ 'errorCode' => 'WhitelistNetType.Format', 'errorMessage' => 'The specified is WhitelistNetType not valid.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'IncorrectDBInstanceCharacterType', 'errorMessage' => 'Current DB Instance character_type does not support this operation.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Items\\": {\\n \\"DBInstanceIPArray\\": [\\n {\\n \\"DBInstanceIPArrayAttribute\\": \\"hidden\\",\\n \\"DBInstanceIPArrayName\\": \\"rds_default\\",\\n \\"SecurityIPList\\": \\"192.168.XX.XX/24\\",\\n \\"SecurityIPType\\": \\"IPv4\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"E2B6AF71-DC32-4055-B477-43B348798D10\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"7463B73D-35CC-4D19-A010-6B8D65D242EF\\",\\n \\"HostId\\": \\"rds.aliyuncs.com\\",\\n \\"Code\\": \\"UnsupportedOperation\\",\\n \\"Message\\": \\"The specified action is not supported.\\"\\n}"},{"type":"xml","example":"\\n\\n\\t\\n\\t\\t\\n\\t\\t\\trds_default\\n\\t\\t\\t\\n\\t\\t\\tVPC\\n\\t\\t\\t192.168.1.0/24\\n\\t\\t\\tIPv4\\n\\t\\t\\n\\t\\n\\tE2B6AF71-DC32-4055-B477-43B348798D10\\n","errorExample":""}]', 'title' => 'DescribeDBInstanceIPArrayList', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* RDS MySQL'."\n" .'* RDS PostgreSQL'."\n" .'* RDS SQL Server'."\n" .'* RDS MariaDB'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeDBInstanceSSL' => [ 'summary' => 'Queries the SSL configurations of an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-bp162dfr55g47****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'ACL' => [ 'description' => 'The method that is used to verify the instance. This parameter is supported only when the instance runs PostgreSQL with cloud disks.'."\n" ."\n" .'* **cert**'."\n" .'* **prefer**'."\n" .'* **verify-ca**'."\n" .'* **verify-full** (supported only when the instance runs PostgreSQL 12 or later)'."\n", 'type' => 'string', 'example' => 'cert', ], 'CAType' => [ 'description' => 'The type of the server certificate. This parameter is supported only when the instance runs PostgreSQL with cloud disks. Valid values:'."\n" ."\n" .'* **aliyun**: a cloud certificate'."\n" .'* **custom**: a custom certificate'."\n", 'type' => 'string', 'example' => 'aliyun', ], 'ClientCACert' => [ 'description' => 'The public key of the CA that issues client certificates. This parameter is supported only when the instance runs PostgreSQL with cloud disks.'."\n", 'type' => 'string', 'example' => '-----BEGIN CERTIFICATE-----MIID*****viXk=-----END CERTIFICATE-----', ], 'ClientCACertExpireTime' => [ 'description' => 'The time when the public key of the CA that issues client certificates expires. This parameter is supported only when the instance runs PostgreSQL with cloud disks. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format and must be in UTC.'."\n" ."\n" .'This parameter is not supported.'."\n", 'type' => 'string', 'example' => '-', ], 'ClientCertRevocationList' => [ 'description' => 'The certificate revocation list (CRL) that contains revoked client certificates. This parameter is supported only when the instance runs PostgreSQL with cloud disks.'."\n", 'type' => 'string', 'example' => '-----BEGIN X509 CRL-----MIIB****19mg==-----END X509 CRL-----', ], 'ConnectionString' => [ 'description' => 'The endpoint that is protected by SSL encryption.'."\n", 'type' => 'string', 'example' => 'rm-bp162dfr55g47****.mysql.rds.aliyuncs.com', ], 'ForceEncryption' => [ 'description' => 'Indicates whether the [forceful SSL encryption](~~95715~~) feature is enabled. This parameter is supported only for RDS for SQL Server instances.'."\n" ."\n" .'* **1**: The feature is enabled.'."\n" .'* **0**: The feature is disabled.'."\n", 'type' => 'string', 'example' => '1', ], 'LastModifyStatus' => [ 'description' => 'The status of the SSL link. This parameter is supported only when the instance runs PostgreSQL with cloud disks.'."\n" ."\n" .'* **success**: The SSL link is successfully configured.'."\n" .'* **setting**: The SSL link is being configured.'."\n" .'* **failed**: The SSL link failed to be configured.'."\n", 'type' => 'string', 'example' => 'setting', ], 'ModifyStatusReason' => [ 'description' => 'The reason why the SSL link stays in the current state. This parameter is supported only when the instance runs PostgreSQL with cloud disks.'."\n", 'type' => 'string', 'example' => 'Modify DB Instance SSL Config.', ], 'ReplicationACL' => [ 'description' => 'The method that is used to verify the replication permission. This parameter is supported only when the instance runs PostgreSQL with cloud disks. Valid values:'."\n" ."\n" .'* **cert**'."\n" .'* **prefer**'."\n" .'* **verify-ca**'."\n" .'* **verify-full** (supported only when the instance runs PostgreSQL 12 or later)'."\n", 'type' => 'string', 'example' => 'cert', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '7705151C-E242-55AF-9929-2A3C39D979D2', ], 'RequireUpdate' => [ 'description' => 'Indicates whether the SSL certificate needs to be updated. Valid values:'."\n" ."\n" .'> An SSL certificate remains valid for one year. Before the used SSL certificate expires, you must update the validity period of the SSL certificate. If you do not update the validity period of the SSL certificate, your application or client that uses encrypted network connections cannot connect to your RDS instance.'."\n" ."\n" .'**RDS instances that run MySQL and SQL Server**'."\n" ."\n" .'* **No**: The SSL certificate does not need to be updated.'."\n" .'* **Yes**: The SSL certificate needs to be updated.'."\n" ."\n" .'**RDS instances that run PostgreSQL**'."\n" ."\n" .'* **0**: The SSL certificate does not need to be updated.'."\n" .'* **1**: The SSL certificate needs to be updated.'."\n", 'type' => 'string', 'example' => 'Yes', ], 'RequireUpdateItem' => [ 'description' => 'The server certificate that needs to be updated. This parameter is supported only when the instance runs PostgreSQL with cloud disk.'."\n", 'type' => 'string', 'example' => '-', ], 'RequireUpdateReason' => [ 'description' => 'The reason why the server certificate needs to be updated. This parameter is supported only when the instance runs PostgreSQL with cloud disks.'."\n", 'type' => 'string', 'example' => '-', ], 'SSLCreateTime' => [ 'description' => 'The time when the server certificate was created. This parameter is supported only when the instance runs PostgreSQL with cloud disks. In addition, this parameter is valid only when the CAType parameter value is aliyun.'."\n", 'type' => 'string', 'example' => '-', ], 'SSLEnabled' => [ 'description' => 'Indicates whether SSL encryption is enabled. Valid values:'."\n" ."\n" .'**RDS instances that run MySQL and SQL Server**'."\n" ."\n" .'* **Yes**: SSL encryption is enabled.'."\n" .'* **No**: SSL encryption is disabled.'."\n" ."\n" .'**RDS instances that run PostgreSQL**'."\n" ."\n" .'* **on**: SSL encryption is enabled.'."\n" .'* **off**: SSL encryption is disabled.'."\n", 'type' => 'string', 'example' => 'Yes', ], 'SSLExpireTime' => [ 'description' => 'The time when the SSL certificate expires. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format and must be in UTC.'."\n", 'type' => 'string', 'example' => '2022-10-11T08:16:43Z', ], 'ServerCAUrl' => [ 'description' => 'The URL of the certificate that is used to issue the server certificate. This parameter is supported only when the instance runs PostgreSQL with cloud disk.'."\n", 'type' => 'string', 'example' => '-', ], 'ServerCert' => [ 'description' => 'The content of the server certificate. This parameter is supported only when the instance runs PostgreSQL with cloud disks.'."\n", 'type' => 'string', 'example' => '-----BEGIN CERTIFICATE-----MIID*****QqEP-----END CERTIFICATE-----', ], 'ServerKey' => [ 'description' => 'The private key of the server certificate. This parameter is supported only when the instance runs PostgreSQL with cloud disks.'."\n", 'type' => 'string', 'example' => '-----BEGIN PRIVATE KEY-----MIIE****ihfg==-----END PRIVATE KEY-----', ], 'TlsVersion' => [ 'description' => 'The [minimum Transport Layer Security (TLS) version](~~95715~~). Valid values: 1.0, 1.1, and 1.2. This parameter is supported only for ApsaraDB RDS for SQL Server instances.'."\n", 'type' => 'string', 'example' => '1.1', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvaildEngineInRegion.ValueNotSupported', 'errorMessage' => 'The engine is not supported in the region.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'Specified Status is not valid.', ], [ 'errorCode' => 'ConcurrentLimit', 'errorMessage' => 'The request processing has been concurrent limit.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OperationDenied.DBInstanceType', 'errorMessage' => 'The operation is not permitted due to type of the instance.', ], [ 'errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations', ], [ 'errorCode' => 'IncorrectEngineVersion', 'errorMessage' => 'Current engine version does not support operations.', ], [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', ], [ 'errorCode' => 'ConnectionStringLengthExceeded', 'errorMessage' => 'Connection String is too long.', ], [ 'errorCode' => 'ResourceConfigError', 'errorMessage' => 'The request processing has failed due to resource config error.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The specified instance is not found.', ], [ 'errorCode' => 'EnabledSSLNotSupport', 'errorMessage' => 'Specified region does not support enable ssl.', ], [ 'errorCode' => 'InvalidConnectionString.NotFound', 'errorMessage' => 'Specified connection string or net type is not found.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"ACL\\": \\"cert\\",\\n \\"CAType\\": \\"aliyun\\",\\n \\"ClientCACert\\": \\"-----BEGIN CERTIFICATE-----MIID*****viXk=-----END CERTIFICATE-----\\",\\n \\"ClientCACertExpireTime\\": \\"-\\",\\n \\"ClientCertRevocationList\\": \\"-----BEGIN X509 CRL-----MIIB****19mg==-----END X509 CRL-----\\",\\n \\"ConnectionString\\": \\"rm-bp162dfr55g47****.mysql.rds.aliyuncs.com\\",\\n \\"ForceEncryption\\": \\"1\\",\\n \\"LastModifyStatus\\": \\"setting\\",\\n \\"ModifyStatusReason\\": \\"Modify DB Instance SSL Config.\\",\\n \\"ReplicationACL\\": \\"cert\\",\\n \\"RequestId\\": \\"7705151C-E242-55AF-9929-2A3C39D979D2\\",\\n \\"RequireUpdate\\": \\"Yes\\",\\n \\"RequireUpdateItem\\": \\"-\\",\\n \\"RequireUpdateReason\\": \\"-\\",\\n \\"SSLCreateTime\\": \\"-\\",\\n \\"SSLEnabled\\": \\"Yes\\",\\n \\"SSLExpireTime\\": \\"2025-06-16T08:16:43Z\\",\\n \\"ServerCAUrl\\": \\"-\\",\\n \\"ServerCert\\": \\"-----BEGIN CERTIFICATE-----MIID*****QqEP-----END CERTIFICATE-----\\",\\n \\"ServerKey\\": \\"-----BEGIN PRIVATE KEY-----MIIE****ihfg==-----END PRIVATE KEY-----\\",\\n \\"TlsVersion\\": \\"1.1\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 7705151C-E242-55AF-9929-2A3C39D979D2\\n Yes\\n 2022-10-11T08:16:43Z\\n Yes\\n \\n rm-bp162dfr55g47****.mysql.rds.aliyuncs.com\\n","errorExample":""}]', 'title' => 'DescribeDBInstanceSSL', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* RDS MySQL'."\n" .'* RDS PostgreSQL'."\n" .'* RDS SQL Server'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'* [Use the SSL encryption feature for an ApsaraDB RDS for MySQL instance](~~96120~~)'."\n" .'* [Use the SSL encryption feature for an ApsaraDB RDS for PostgreSQL instance](~~229518~~)'."\n" .'* [Use the SSL encryption feature for an ApsaraDB RDS for SQL Server instance](~~95715~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeDBInstanceTDE' => [ 'summary' => 'Queries the status of the Transparent Data Encryption (TDE) feature for an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5xxxxxxx', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Databases' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Database' => [ 'description' => 'The TDE status at the database level.'."\n" ."\n" .'> If your instance runs SQL Server 2019 SE or SQL Server EE, you can specify whether to enable TDE at the database level when you enable TDE at the instance level.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'DBName' => [ 'description' => 'The name of the database.'."\n", 'type' => 'string', 'example' => 'test02', ], 'TDEStatus' => [ 'description' => 'The TDE status at the database level. Valid values:'."\n" ."\n" .'* **Enabled**'."\n" .'* **Disabled**'."\n", 'type' => 'string', 'example' => 'Enabled', ], ], ], ], ], ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'C816A4BF-A6EC-4722-95F9-2055859CCFD2', ], 'TDEMode' => [ 'description' => 'The method that is used to generate the key for TDE at the instance level. Valid values:'."\n" ."\n" .'* **Aliyun_Generate_Key**'."\n" .'* **Customer_Provided_Key**'."\n" .'* **Unknown**'."\n", 'type' => 'string', 'example' => 'Aliyun_Generate_Key', ], 'TDEStatus' => [ 'description' => 'The TDE status of the instance. Valid values:'."\n" ."\n" .'* **Enabled**'."\n" .'* **Disabled**'."\n", 'type' => 'string', 'example' => 'Enabled', ], 'EncryptionKey' => [ 'type' => 'string', 'example' => '749c1df7-****-****-****-****', 'description' => 'The ID of the custom key.'."\n", ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => '%s', 'errorMessage' => 'DB Operation Failed:%s.', ], [ 'errorCode' => 'Connect.Timeout', 'errorMessage' => 'Service can not connect to instance temporarily.', ], [ 'errorCode' => 'SqlExcutionFailed', 'errorMessage' => 'Failed to connect to host: connection timed out.', ], [ 'errorCode' => 'DbossGeneralError', 'errorMessage' => 'The instance is being created. Please wait.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'ConcurrentLimit', 'errorMessage' => 'The request processing has been concurrent limit.', ], ], 403 => [ [ 'errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance engine and type does not support operations.', ], [ 'errorCode' => 'IncorrectEngineVersion', 'errorMessage' => 'The engine version does not support the operation.', ], [ 'errorCode' => 'DBSizeExceeded', 'errorMessage' => 'Exceeding the allowed DB size of DB instance.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBName.NotFound', 'errorMessage' => 'Specified one or more DB name does not exist or DB status does not support.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 408 => [ [ 'errorCode' => 'NetworkOrSqlTimeoutError', 'errorMessage' => 'Failed to create login due to potential SQL Server overload or other issues that may cause the login creation fail. Please retry later.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Databases\\": {\\n \\"Database\\": [\\n {\\n \\"DBName\\": \\"test02\\",\\n \\"TDEStatus\\": \\"Enabled\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"C816A4BF-A6EC-4722-95F9-2055859CCFD2\\",\\n \\"TDEMode\\": \\"Aliyun_Generate_Key\\",\\n \\"TDEStatus\\": \\"Enabled\\",\\n \\"EncryptionKey\\": \\"key-szz644a355asjcuilll4u\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"7463B73D-35CC-4D19-A010-6B8D65D242EF\\",\\n \\"HostId\\": \\"rds.aliyuncs.com\\",\\n \\"Code\\": \\"UnsupportedOperation\\",\\n \\"Message\\": \\"The specified action is not supported.\\"\\n}"},{"type":"xml","example":"\\n\\n\\tEnabled\\n\\t\\n\\t\\ttest02\\n\\t\\tEnabled\\n\\t\\n\\tC816A4BF-A6EC-4722-95F9-2055859CCFD2\\n\\n\\t\\n","errorExample":""}]', 'title' => 'DescribeDBInstanceTDE', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeDBInstanceEncryptionKey' => [ 'summary' => 'You can call the DescribeDBInstanceEncryptionKey operation to check whether disk encryption is enabled for an instance. You can also query details about the keys that are used for disk encryption. This operation is supported for instances that run MySQL, SQL Server, or PostgreSQL.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the instance. You can call the [DescribeRegions](~~26243~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the instance You can call the [DescribeDBInstances](~~26232~~) operation to query the IDs of instances.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'rm-uf6wjk5xxxxxxx', ], ], [ 'name' => 'EncryptionKey', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the custom key.'."\n", 'type' => 'string', 'required' => false, 'example' => '749c1df7-xxxx-xxxx-xxxx-xxxxxxxxxxxx', ], ], [ 'name' => 'TargetRegionId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the destination region. You can call the [DescribeRegions](~~26243~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-qingdao', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Creator' => [ 'description' => 'The user who created the key.'."\n", 'type' => 'string', 'example' => '1443*****9604', ], 'DeleteDate' => [ 'description' => 'The scheduled time at which the key is deleted. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2022-05-08T08:14:16Z', ], 'Description' => [ 'description' => 'The description of the key.'."\n", 'type' => 'string', 'example' => 'Description of the key', ], 'EncryptionKey' => [ 'description' => 'The ID of the key.'."\n", 'type' => 'string', 'example' => '5306d1b6-7fd3-42d9-9511-xxxxxxx', ], 'EncryptionKeyList' => [ 'description' => 'The details about the key.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The list of keys.'."\n", 'type' => 'object', 'properties' => [ 'AliasName' => [ 'description' => 'The alias of the key.'."\n", 'type' => 'string', 'example' => 'alias/xxx', ], 'Creator' => [ 'description' => 'The user who created the key.'."\n", 'type' => 'string', 'example' => '1443*****9604', ], 'DeleteDate' => [ 'description' => 'The scheduled time at which the key is deleted. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2022-05-08T08:14:16Z', ], 'Description' => [ 'description' => 'The description of the key.'."\n", 'type' => 'string', 'example' => 'Description of the key', ], 'EncryptionKey' => [ 'description' => 'The ID of the key.'."\n", 'type' => 'string', 'example' => '5306d1b6-7fd3-42d9-9511-xxxxxxx', ], 'EncryptionKeyStatus' => [ 'description' => 'The status of the key. Valid values:'."\n" ."\n" .'* **Enabled**'."\n" .'* **Disabled**'."\n", 'type' => 'string', 'example' => 'Enabled', ], 'KeyType' => [ 'description' => 'The type of the key. Valid values:'."\n" ."\n" .'* **CMK**'."\n" .'* **ServiceKey**', 'type' => 'string', 'example' => 'ServiceKey', ], 'KeyUsage' => [ 'description' => 'The purpose of the key.'."\n", 'type' => 'string', 'example' => 'ENCRYPT/DECRYPT', ], 'MaterialExpireTime' => [ 'description' => 'The time at which the key expires. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2021-10-18T08:14:16Z', ], 'Origin' => [ 'description' => 'The source of the key.'."\n", 'type' => 'string', 'example' => 'Aliyun_KMS', ], 'UsedBy' => [ 'description' => 'The role of the instance. Valid values:'."\n" ."\n" .'* **Master**: primary instance'."\n" .'* **slave**: read-only instance'."\n", 'type' => 'string', 'example' => 'Master', ], ], ], ], 'EncryptionKeyStatus' => [ 'description' => 'The status of the key. Valid values:'."\n" ."\n" .'* **Enabled**'."\n" .'* **Disabled**'."\n", 'type' => 'string', 'example' => 'Enabled', ], 'KeyUsage' => [ 'description' => 'The purpose of the key.'."\n", 'type' => 'string', 'example' => 'ENCRYPT/DECRYPT', ], 'MaterialExpireTime' => [ 'description' => 'The time at which the key expires. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2021-10-18T08:14:16Z', ], 'Origin' => [ 'description' => 'The source of the key.'."\n", 'type' => 'string', 'example' => 'Aliyun_KMS', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '3BC2768E-DEDA-40FC-BBE9-6B884F3626AF', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'NoActiveBYOK', 'errorMessage' => 'This custins no active byok.', ], [ 'errorCode' => 'ByokInsnameAndRegionAllEmpty', 'errorMessage' => 'The insName and targetRegionId can\'t be all empty.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Creator\\": \\"1443****9604\\",\\n \\"DeleteDate\\": \\"2022-05-08T08:14:16Z\\",\\n \\"Description\\": \\"Description of the key\\",\\n \\"EncryptionKey\\": \\"5306d1b6-7fd3-42d9-9511-****\\",\\n \\"EncryptionKeyList\\": [\\n {\\n \\"AliasName\\": \\"alias/****\\",\\n \\"Creator\\": \\"1443****9604\\",\\n \\"DeleteDate\\": \\"2022-05-08T08:14:16Z\\",\\n \\"Description\\": \\"Description of the key\\",\\n \\"EncryptionKey\\": \\"5306d1b6-7fd3-42d9-9511-****\\",\\n \\"EncryptionKeyStatus\\": \\"Enabled\\",\\n \\"KeyType\\": \\"ServiceKey\\",\\n \\"KeyUsage\\": \\"ENCRYPT/DECRYPT\\",\\n \\"MaterialExpireTime\\": \\"2021-10-18T08:14:16Z\\",\\n \\"Origin\\": \\"Aliyun_KMS\\",\\n \\"UsedBy\\": \\"TDE\\"\\n }\\n ],\\n \\"EncryptionKeyStatus\\": \\"Enabled\\",\\n \\"KeyUsage\\": \\"ENCRYPT/DECRYPT\\",\\n \\"MaterialExpireTime\\": \\"2021-10-18T08:14:16Z\\",\\n \\"Origin\\": \\"Aliyun_KMS\\",\\n \\"RequestId\\": \\"3BC2768E-DEDA-40FC-BBE9-6B884F3626AF\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 2022-05-08T08:14:16Z\\n 3BC2768E-DEDA-40FC-BBE9-6B884F3626AF\\n Description of the key\\n Aliyun_KMS\\n 2021-10-18T08:14:16Z\\n Enabled\\n ENCRYPT/DECRYPT\\n 5306d1b6-7fd3-42d9-9511-xxxxxxx\\n 1443*****9604\\n \\n ALIAS\\n 5306d1b6-7fd3-42d9-9511-xxxxxxx\\n Description of the key\\n ENCRYPT/DECRYPT\\n 2022-05-08T08:14:16Z\\n 1443*****9604\\n Enabled\\n Aliyun_KMS\\n 2021-10-18T08:14:16Z\\n alias/xxx\\n master\\n \\n","errorExample":""}]', 'title' => 'DescribeDBInstanceEncryptionKey', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeDBInstanceIpHostname' => [ 'summary' => 'Queries the internal IP address and hostname of the Elastic Compute Service (ECS) instance on which the ApsaraDB RDS for SQL Server instance runs.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the [DescribeDBInstances](~~2628785~~) operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5xxxxxxx', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the [DescribeDBInstanceAttribute](~~2628783~~) operation to query the region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'DBInstanceId' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5xxxxxxx', ], 'IpHostnameInfos' => [ 'description' => 'The internal IP addresses and hostnames of the ECS instance on which a primary ApsaraDB RDS for SQL Server instance and its secondary RDS instance reside. Format: `IP address 1, Hostname 1; IP address 2, Hostname 2`.'."\n", 'type' => 'string', 'example' => '172.16.xx.xx,sdxxxxxxxxB;172.16.xx.xx,sdxxxxxxxxA', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '67CD4719-51E3-4A76-A38C-02F45FAE7E36', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'EngineNotSupported', 'errorMessage' => 'Engine specified cannot be supported the operation.', ], [ 'errorCode' => 'InvalidEngineVersion.Malformed', 'errorMessage' => 'Specified engine version is not valid.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance engine and type does not support operations.', ], [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'Invalid DBInstanceId NotFound.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBInstanceId\\": \\"rm-uf6wjk5****\\",\\n \\"IpHostnameInfos\\": \\"172.16.xx.xx,sd****B;172.16.xx.xx,sd****A\\",\\n \\"RequestId\\": \\"67CD4719-51E3-4A76-A38C-02F45FAE7E36\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n172.16.xx.xx,sdxxxxxxxxB;172.16.xx.xxx,sdxxxxxxxxA\\r\\n\\trm-uf6wjk5xxxxxxx\\r\\n\\t67CD4719-51E3-4A76-A38C-02F45FAE7E36\\r\\n","errorExample":""}]', 'title' => 'DescribeDBInstanceIpHostname', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'SQL Server'."\n" ."\n" .'### [](#)Prerequisites'."\n" ."\n" .'* The RDS instance runs RDS Basic Edition, RDS High-availability Edition, or RDS Cluster Edition. If your RDS instance runs RDS High-availability Edition, make sure that the instance runs SQL Server 2012 or later.'."\n" .'* The RDS instance belongs to a general-purpose or dedicated instance family. The shared instance family is not supported.'."\n" .'* If the RDS instance runs RDS Basic Edition, the instance is created on or after September 02, 2022. You can view the Creation Time parameter of an instance in the Status section of the Basic Information page in the ApsaraDB RDS console.'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> Before you call this operation, read the following documentation and make sure that you fully understand the prerequisites and impacts of this operation.'."\n" ."\n" .'* [Configure a distributed transaction whitelist](~~124321~~)'."\n" .'* [Connect Kingdee K/3 WISE to an ApsaraDB RDS for SQL Server instance](~~124188~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeDTCSecurityIpHostsForSQLServer' => [ 'summary' => 'Queries the distributed transaction whitelists of an ApsaraDB RDS for SQL Server instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5xxxxxxx', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the DescribeDBInstanceAttribute operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The resource group ID. You can call the DescribeDBInstanceAttribute operation to query the resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy*****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'DBInstanceId' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5xxxxxxx', ], 'IpHostPairNum' => [ 'description' => 'The number of distributed transaction whitelists.'."\n", 'type' => 'string', 'example' => '1', ], 'Items' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'WhiteListGroups' => [ 'description' => 'Details of distributed transaction whitelists.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'SecurityIpHosts' => [ 'description' => 'The IP address of the ECS instance and the hostname of the Windows computer. Format: `IP address,Hostname`. Multiple values are separated with semicolons (;).'."\n", 'type' => 'string', 'example' => '192.168.1.100,k3ecstest', ], 'WhitelistGroupName' => [ 'description' => 'The name of the distributed transaction whitelist.'."\n", 'type' => 'string', 'example' => 'test1', ], ], ], ], ], ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '2CA62A70-2203-45C6-8E90-8971D5ACC0C2', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBInstanceId\\": \\"rm-uf6wjk5****\\",\\n \\"IpHostPairNum\\": \\"1\\",\\n \\"Items\\": {\\n \\"WhiteListGroups\\": [\\n {\\n \\"SecurityIpHosts\\": \\"192.168.XX.XX,k3ecstest\\",\\n \\"WhitelistGroupName\\": \\"test1\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"2CA62A70-2203-45C6-8E90-8971D5ACC0C2\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n\\t\\t\\r\\n\\t\\t\\ttest1\\r\\n\\t\\t\\t192.168.1.100,k3ecstest\\r\\n\\t\\t\\r\\n\\t\\r\\n\\t1\\r\\n\\t2CA62A70-2203-45C6-8E90-8971D5ACC0C2\\r\\n","errorExample":""}]', 'title' => 'DescribeDTCSecurityIpHostsForSQLServer', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'SQL Server'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.'."\n" ."\n" .'[Configures a distributed transaction whitelist for an ApsaraDB RDS for SQL Server instance](~~124321~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'MigrateSecurityIPMode' => [ 'summary' => 'Changes the whitelist mode of an instance from the standard whitelist mode to the enhanced whitelist mode.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-uf6wjk5****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'DBInstanceId' => [ 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5****', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'EF1E53AB-5625-49C7-ADF1-FBD0B6640D19', ], 'SecurityIPMode' => [ 'description' => 'The whitelist mode after the change, which is the enhanced whitelist mode.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'* safety'."\n" ."\n" .' '."\n" ."\n" .' :'."\n" ."\n" .' '."\n" ."\n" .' enhanced whitelist mode'."\n" ."\n" .' '."\n", 'type' => 'string', 'enumValueTitles' => [ 'safety' => 'safety', ], 'example' => 'safety', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBInstanceId\\": \\"rm-uf6wjk5****\\",\\n \\"RequestId\\": \\"EF1E53AB-5625-49C7-ADF1-FBD0B6640D19\\",\\n \\"SecurityIPMode\\": \\"safety\\"\\n}","errorExample":""},{"type":"xml","example":"\\n\\n\\trm-uf6wjk5xxxxxxx\\n\\tEF1E53AB-5625-49C7-ADF1-FBD0B6640D19\\n\\tsafety\\n\\n\\t","errorExample":""}]', 'title' => 'MigrateSecurityIPMode', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.'."\n" ."\n" .'* [Change the whitelist mode of an ApsaraDB RDS for MySQL instance to the enhanced whitelist mode](~~96117~~)'."\n" .'* [Change the whitelist mode of an ApsaraDB RDS for PostgreSQL instance to the enhanced whitelist mode](~~96767~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeSQLLogReportList' => [ 'summary' => 'Queries SQL log reports.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-uf6wjk5xxxxxxx', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => true, 'example' => '2021-03-13T16:00:00Z', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => 'The end of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-ddTHH:mm:ssZ* format. The time must be in UTC.**'."\n" ."\n" .'> The end time must be later than the start time.'."\n", 'type' => 'string', 'required' => true, 'example' => '2021-03-18T16:00:00Z', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page. Valid values:'."\n" ."\n" .'* **30**'."\n" .'* **50**'."\n" .'* **100**'."\n" ."\n" .'Default value: **30**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '50', 'minimum' => '1', 'example' => '30', 'default' => '5', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => 'The page number. Valid values: any **non-zero** positive integer.'."\n" ."\n" .'Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'default' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Items' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Item' => [ 'description' => 'An array that consists of SQL log reports.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'LatencyTopNItems' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'LatencyTopNItem' => [ 'description' => 'An array that consists of SQL statements executed with the highest latency.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'AvgLatency' => [ 'description' => 'The average time that is required to execute the SQL statement. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '500', ], 'SQLExecuteTimes' => [ 'description' => 'The number of times that the SQL statement is executed.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '5', ], 'SQLText' => [ 'description' => 'The SQL statement.'."\n" ."\n" .'> Only the first 128 characters of the SQL statement are returned. In addition, only the SQL statements that take more than 100 ms to execute are returned.'."\n", 'type' => 'string', 'example' => 'SELECT * FROM table_name;', ], ], ], ], ], ], 'QPSTopNItems' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'QPSTopNItem' => [ 'description' => 'An array that consists of SQL statements executed the most frequently.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'SQLExecuteTimes' => [ 'description' => 'The number of times that the SQL statement is executed.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '5', ], 'SQLText' => [ 'description' => 'The SQL statement.'."\n" ."\n" .'> Only the first 128 characters of the SQL statement are returned. In addition, only the SQL statements that take more than 5 ms to execute are returned.'."\n", 'type' => 'string', 'example' => 'SELECT * FROM table_name;', ], ], ], ], ], ], 'ReportTime' => [ 'description' => 'The time when the report was generated. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2019-03-27T16:00:00Z', ], ], ], ], ], ], 'PageNumber' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageRecordCount' => [ 'description' => 'The number of SQL log reports on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '08A3B71B-FE08-4B03-974F-CC7EA6DB1828 ', ], 'TotalRecordCount' => [ 'description' => 'The total number of entries.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '60', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Items\\": {\\n \\"Item\\": [\\n {\\n \\"LatencyTopNItems\\": {\\n \\"LatencyTopNItem\\": [\\n {\\n \\"AvgLatency\\": 500,\\n \\"SQLExecuteTimes\\": 5,\\n \\"SQLText\\": \\"SELECT * FROM table_name;\\"\\n }\\n ]\\n },\\n \\"QPSTopNItems\\": {\\n \\"QPSTopNItem\\": [\\n {\\n \\"SQLExecuteTimes\\": 5,\\n \\"SQLText\\": \\"SELECT * FROM table_name;\\"\\n }\\n ]\\n },\\n \\"ReportTime\\": \\"2019-03-27T16:00:00Z\\"\\n }\\n ]\\n },\\n \\"PageNumber\\": 1,\\n \\"PageRecordCount\\": 30,\\n \\"RequestId\\": \\"08A3B71B-FE08-4B03-974F-CC7EA6DB1828\\\\t\\",\\n \\"TotalRecordCount\\": 60\\n}","errorExample":""},{"type":"xml","example":"\\n 60\\n 30\\n 08A3B71B-FE08-4B03-974F-CC7EA6DB1828\\t\\n 1\\n \\n \\n 2019-03-27T16:00:00Z\\n \\n \\n 500\\n 5\\n SELECT * FROM table_name;\\n \\n \\n \\n \\n 5\\n SELECT * FROM table_name;\\n \\n \\n \\n \\n","errorExample":""}]', 'title' => 'DescribeSQLLogReportList', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" .'* MariaDB'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'PurgeDBInstanceLog' => [ 'summary' => 'Clears the on-premises logs of an ApsaraDB RDS instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxxxxx', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5xxxxxxx', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '65BDA532-28AF-4122-AA39-B382721EEE64', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', ], [ 'errorCode' => 'ConcurrentTaskExceeded', 'errorMessage' => 'Concurrent task exceeding the allowed amount.', ], [ 'errorCode' => 'IncorrectDBInstanceEngine', 'errorMessage' => 'Current DB Instance engine does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstanceCharacterType', 'errorMessage' => 'Current DB Instance character_type does not support this operation.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'Specified instance does not exist or not support.', ], [ 'errorCode' => 'InvalidPage.NotFound', 'errorMessage' => 'Page not found.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"65BDA532-28AF-4122-AA39-B382721EEE64\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"7463B73D-35CC-4D19-A010-6B8D65D242EF\\",\\n \\"HostId\\": \\"rds.aliyuncs.com\\",\\n \\"Code\\": \\"UnsupportedOperation\\",\\n \\"Message\\": \\"The specified action is not supported.\\"\\n}"},{"type":"xml","example":"\\n\\n\\t 65BDA532-28AF-4122-AA39-B382721EEE64\\n\\t\\n","errorExample":""}]', 'title' => 'PurgeDBInstanceLog', 'description' => '### Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* SQL Server'."\n" ."\n" .'### Description'."\n" ."\n" .'The system automatically uploads log backup files to Object Storage Service (OSS) buckets. If the remaining storage of an instance is insufficient, you can call this operation to upload the log backup files of the instance to OSS buckets. After the upload is complete, the system deletes these files from the instance to release storage. This operation is called to upload log backup files from an instance to OSS buckets and then delete these files from the instance. If the instance runs SQL Server, transaction log backup files are compressed before they are uploaded.'."\n" ."\n" .'### Precautions'."\n" ."\n" .'* When you upload log backup files, the data restoration feature is not affected.'."\n" .'* This operation is called to release storage. The backup storage usage is not reduced.'."\n" .'* The OSS buckets to which log backup files are uploaded are provided by the system. You do not need to purchase these OSS buckets. In addition, you cannot access these OSS buckets.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeSQLLogFiles' => [ 'summary' => 'Queries the log files that are generated by the SQL Explorer (SQL Audit) feature for an instance. The DescribeSQLLogFiles operation does not return the log files that are generated by the SQL Explorer feature and manually exported from the ApsaraDB RDS console. The DescribeSQLLogFiles operation returns the SQL Explorer log files that are generated by calling the DescribeSQLLogRecords operation with the request parameter Form set to File.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-uf6wjk5xxxxxx', ], ], [ 'name' => 'FileName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the audit log file.'."\n", 'type' => 'string', 'required' => false, 'example' => 'custinsxxxxx.csv', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page. Valid values: **30 to 200**. Default value: **30**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '200', 'minimum' => '30', 'example' => '30', 'default' => '30', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => 'The page number. Valid values: **1 to 100000**. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'default' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Items' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'LogFile' => [ 'description' => 'An array that consists of the returned audit log files.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'FileID' => [ 'description' => 'The file name.'."\n", 'type' => 'string', 'example' => 'custinsxxxxx.csv', ], 'LogDownloadURL' => [ 'description' => 'The download URL of the file. If the audit log file cannot be downloaded, this parameter is null.'."\n", 'type' => 'string', 'example' => 'http://rdslog-hz-v3.oss-cn-hangzhou.aliyuncs.com/xxxxx', ], 'LogEndTime' => [ 'description' => 'The time at which the last SQL statement recorded in the audit log file was executed. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2015-05-24T07:00:00Z', ], 'LogSize' => [ 'description' => 'The size of the audit log file. Unit: bytes.'."\n", 'type' => 'string', 'example' => '3000', ], 'LogStartTime' => [ 'description' => 'The time at which the first SQL statement recorded in the audit log file was executed. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2015-05-23T07:00:00Z', ], 'LogStatus' => [ 'description' => 'The status of the audit log file. Valid values:'."\n" ."\n" .'* **Success**'."\n" .'* **Failed**'."\n" .'* **Generating**'."\n", 'type' => 'string', 'example' => 'Success', ], ], ], ], ], ], 'PageNumber' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageRecordCount' => [ 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => ' 1AD222E9-E606-4A42-BF6D-8A4442913CEF', ], 'TotalRecordCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], 504 => [ [ 'errorCode' => 'OperationDenied.Timeout', 'errorMessage' => 'The request processing has failed due to timeout.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Items\\": {\\n \\"LogFile\\": [\\n {\\n \\"FileID\\": \\"custins****.csv\\",\\n \\"LogDownloadURL\\": \\"http://rdslog-hz-v3.oss-cn-hangzhou.aliyuncs.com/****\\",\\n \\"LogEndTime\\": \\"2015-05-24T07:00:00Z\\",\\n \\"LogSize\\": \\"3000\\",\\n \\"LogStartTime\\": \\"2015-05-23T07:00:00Z\\",\\n \\"LogStatus\\": \\"Success\\"\\n }\\n ]\\n },\\n \\"PageNumber\\": 1,\\n \\"PageRecordCount\\": 10,\\n \\"RequestId\\": \\" 1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"TotalRecordCount\\": 10\\n}","errorExample":"{\\n \\"RequestId\\": \\"7463B73D-35CC-4D19-A010-6B8D65D242EF\\",\\n \\"HostId\\": \\"rds.aliyuncs.com\\",\\n \\"Code\\": \\"UnsupportedOperation\\",\\n \\"Message\\": \\"The specified action is not supported.\\"\\n}"},{"type":"xml","example":"\\n\\n\\t\\n\\t\\tZUBaS964T3OYtxxxxxxxx\\n\\t\\tSuccess\\n\\t\\t2015-05-23T07:00:00Z\\n\\t\\t2015-05-23T07:00:00Z\\n\\t\\txxxxxx.cn-hangzhou.oss.aliyun-inc.com/xxxxx\\n\\t\\t257\\n\\t\\n\\t1\\n\\t 1AD222E9-E606-4A42-BF6D-8A4442913CEF\\n\\t1\\n\\n\\t","errorExample":""}]', 'title' => 'DescribeSQLLogFiles', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" ."\n" .'* PostgreSQL'."\n" ."\n" .'* SQL Server'."\n" ."\n" .' **'."\n" ."\n" .' **Note** If your instance runs SQL Server, only SQL Server 2008 R2 is supported.'."\n" ."\n" .'### [](#)Precautions'."\n" ."\n" .'* The DescribeSQLLogFiles operation does not return the log files that are generated by SQL Explorer Trial Edition for an ApsaraDB RDS for MySQL instance.'."\n" ."\n" .'* The DescribeSQLLogFiles operation does not return the log files that are generated by the SQL Explorer feature and manually exported from the ApsaraDB RDS console. The DescribeSQLLogFiles operation returns the SQL Explorer log files that are generated by calling the [DescribeSQLLogRecords](~~610533~~) operation with the request parameter **Form** set to **File**.'."\n" ."\n" .'* The exported files are retained for only two days.'."\n" ."\n" .' **'."\n" ."\n" .' **Note** If you have enabled Database Autonomy Service (DAS) Enterprise Edition V2 or V3 and have enabled the SQL Explorer and Audit feature, the exported files are retained for seven days. You can call the [DescribeSqlLogConfig](~~2778837~~) operation to query the information about the enabled DAS Enterprise Edition.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeSlowLogs' => [ 'summary' => 'Queries the statistics on slow query logs.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5xxxxxxx', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*Z format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2011-05-01Z', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => 'The end of the time range to query. The end time must be later than the start time. The time span between the start time and the end time cannot exceed 31 days. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*Z format. The time must be in UTC.'."\n" ."\n" .'> If the end date of the query is the same as the start date of the query, you can query the logs that are generated at 08:00 on the start date of the query. You can query the slow logs within a maximum time range of 24 hours.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2011-05-30Z', ], ], [ 'name' => 'DBName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => false, 'example' => 'RDS_MySQL', ], ], [ 'name' => 'SortKey', 'in' => 'query', 'schema' => [ 'description' => 'The dimension based on which the system sorts the entries to return. Valid values:'."\n" ."\n" .'* **TotalExecutionCounts**: The system sorts the entries to return based on the number of times that SQL statements are executed.'."\n" .'* **TotalQueryTimes**: The system sorts the entries to return based on the total execution duration.'."\n" .'* **TotalLogicalReads**: The system sorts the entries to return based on the total number of logical reads.'."\n" .'* **TotalPhysicalReads**: The system sorts the entries to return based on the total number of physical reads.'."\n" ."\n" .'> This parameter is supported only for instances that run SQL Server 2008 R2.'."\n", 'type' => 'string', 'required' => false, 'example' => 'TotalExecutionCounts', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page. Valid values: **30** to **100**. Default value: **30**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '30', 'example' => '30', 'default' => '30', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => 'The page number. Pages start from 1.'."\n" ."\n" .'Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '65535', 'minimum' => '1', 'example' => '1', 'default' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'DBInstanceId' => [ 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5xxxxxxx', ], 'EndTime' => [ 'description' => 'The end date of the query.'."\n", 'type' => 'string', 'example' => '2011-05-30Z', ], 'Engine' => [ 'description' => 'The database engine of the instance.'."\n", 'type' => 'string', 'example' => 'MySQL', ], 'Items' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'SQLSlowLog' => [ 'description' => 'An array that consists of the information about each slow query log.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'AvgExecutionTime' => [ 'description' => 'The average execution duration per SQL statement in the query. Unit: seconds.'."\n" ."\n" .'> This parameter is returned only for instances that run SQL Server.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'AvgIOWriteCounts' => [ 'description' => 'The average number of I/O writes per SQL statement in the query.'."\n" ."\n" .'> This parameter is returned only for instances that run SQL Server.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'AvgLastRowsAffectedCounts' => [ 'description' => 'The average number of rows that were affected by the last SQL statement in the query.'."\n" ."\n" .'> This parameter is returned only for instances that run SQL Server.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'AvgLogicalReadCounts' => [ 'description' => 'The average number of logical reads per SQL statement in the query.'."\n" ."\n" .'> This parameter is returned only for instances that run SQL Server.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'AvgPhysicalReadCounts' => [ 'description' => 'The average number of physical reads per SQL statement in the query.'."\n" ."\n" .'> This parameter is returned only for instances that run SQL Server.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'AvgRowsAffectedCounts' => [ 'description' => 'The average number of rows that were affected per SQL statement in the query.'."\n" ."\n" .'> This parameter is returned only for instances that run SQL Server.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'CreateTime' => [ 'description' => 'The date when the data was generated.'."\n", 'type' => 'string', 'example' => '2011-05-30Z', ], 'DBName' => [ 'description' => 'The name of the database.'."\n", 'type' => 'string', 'example' => 'RDS_MySQL', ], 'MaxExecutionTime' => [ 'description' => 'The longest execution duration of a specific SQL statement in the query. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '60', ], 'MaxExecutionTimeMS' => [ 'description' => 'The longest execution duration of a specific SQL statement in the query. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '60000', ], 'MaxIOWriteCounts' => [ 'description' => 'The largest number of I/O writes that were performed by a specific SQL statement in the query.'."\n" ."\n" .'> This parameter is returned only for instances that run SQL Server.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'MaxLastRowsAffectedCounts' => [ 'description' => 'The largest number of rows that were affected by the last SQL statement in the query.'."\n" ."\n" .'> This parameter is returned only for instances that run SQL Server.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'MaxLockTime' => [ 'description' => 'The longest lock duration that was caused by a specific SQL statement in the query. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'MaxLockTimeMS' => [ 'description' => 'The longest lock duration that was caused by a specific SQL statement in the query. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1000', ], 'MaxLogicalReadCounts' => [ 'description' => 'The largest number of logical reads that were performed by a specific SQL statement in the query.'."\n" ."\n" .'> This parameter is returned only for instances that run SQL Server.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'MaxPhysicalReadCounts' => [ 'description' => 'The largest number of physical reads that were performed by a specific SQL statement in the query.'."\n" ."\n" .'> This parameter is returned only for instances that run SQL Server.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'MaxRowsAffectedCounts' => [ 'description' => 'The largest number of rows that were affected by a specific SQL statement in the query.'."\n" ."\n" .'> This parameter is returned only for instances that run SQL Server.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'MinIOWriteCounts' => [ 'description' => 'The smallest number of I/O writes that were performed by a specific SQL statement in the query.'."\n" ."\n" .'> This parameter is returned only for instances that run SQL Server.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'MinLastRowsAffectedCounts' => [ 'description' => 'The smallest number of rows that were affected by the last SQL statement in the query.'."\n" ."\n" .'> This parameter is returned only for instances that run SQL Server.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'MinLogicalReadCounts' => [ 'description' => 'The smallest number of logical reads that were performed by a specific SQL statement in the query.'."\n" ."\n" .'> This parameter is returned only for instances that run SQL Server.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'MinPhysicalReadCounts' => [ 'description' => 'The smallest number of physical reads that were performed by a specific SQL statement in the query.'."\n" ."\n" .'> This parameter is returned only for instances that run SQL Server.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'MinRowsAffectedCounts' => [ 'description' => 'The smallest number of rows that were affected by a specific SQL statement in the query.'."\n" ."\n" .'> This parameter is returned only for instances that run SQL Server.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'MySQLTotalExecutionCounts' => [ 'description' => 'The total number of SQL statements that were executed in the query. This parameter is returned only for instances that run MySQL.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'MySQLTotalExecutionTimes' => [ 'description' => 'The total execution duration of all SQL statements in the query. Unit: seconds. This parameter is returned only for instances that run MySQL.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'ParseMaxRowCount' => [ 'description' => 'The largest number of rows that were parsed by a specific SQL statement in the query.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'ParseTotalRowCounts' => [ 'description' => 'The total number of rows that were parsed by all SQL statements in the query.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'ReportTime' => [ 'description' => 'The date on which the data report was generated.'."\n", 'type' => 'string', 'example' => '2011-05-30Z', ], 'ReturnMaxRowCount' => [ 'description' => 'The largest number of rows that were returned by a specific SQL statement in the query.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'ReturnTotalRowCounts' => [ 'description' => 'The total number of rows that were returned by all SQL statements in the query.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'SQLHASH' => [ 'description' => 'The unique ID of the SQL statement. The ID is used to obtain the slow query logs of the SQL statement.'."\n", 'type' => 'string', 'example' => 'U2FsdGVkxxxx', ], 'SQLIdStr' => [ 'description' => 'The ID of the SQL statement in the statistical template of slow query logs. This parameter is replaced by the **SQLHASH** parameter.'."\n", 'type' => 'string', 'example' => '521584', ], 'SQLServerAvgCpuTime' => [ 'description' => 'The average amount of CPU time per SQL statement in the query. Unit: seconds.'."\n" ."\n" .'> This parameter is returned only for instances that run SQL Server.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'SQLServerAvgExecutionTime' => [ 'description' => 'The average execution duration per SQL statement in the query. Unit: seconds.'."\n" ."\n" .'> This parameter is returned only for instances that run SQL Server.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'SQLServerMaxCpuTime' => [ 'description' => 'The largest amount of CPU time that was used by a specific SQL statement in the query. Unit: seconds.'."\n" ."\n" .'> This parameter is returned only for instances that run SQL Server.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'SQLServerMinCpuTime' => [ 'description' => 'The smallest amount of CPU time that was used by a specific SQL statement in the query. Unit: seconds.'."\n" ."\n" .'> This parameter is returned only for instances that run SQL Server.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'SQLServerMinExecutionTime' => [ 'description' => 'The smallest execution duration of a specific SQL statement in the query. Unit: seconds.'."\n" ."\n" .'> This parameter is returned only for instances that run SQL Server.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'SQLServerTotalCpuTime' => [ 'description' => 'The total amount of CPU time that was used by all SQL statements in the query. Unit: seconds.'."\n" ."\n" .'> This parameter is returned only for instances that run SQL Server.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'SQLServerTotalExecutionCounts' => [ 'description' => 'The total number of SQL statements that were executed in the query. This parameter is returned only for instances that run SQL Server.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'SQLServerTotalExecutionTimes' => [ 'description' => 'The total execution duration of all SQL statements in the query. This parameter is returned only for instances that run SQL Server. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1000', ], 'SQLText' => [ 'description' => 'The SQL statement that was executed in the query.'."\n", 'type' => 'string', 'example' => 'select id,name from tb_table', ], 'SlowLogId' => [ 'description' => 'The ID of the slow query log summary.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '26584213', ], 'TotalIOWriteCounts' => [ 'description' => 'The total number of I/O writes that were performed by all SQL statements in the query.'."\n" ."\n" .'> This parameter is returned only for instances that run SQL Server.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'TotalLastRowsAffectedCounts' => [ 'description' => 'The total number of rows that were affected by the last SQL statement in the query.'."\n" ."\n" .'> This parameter is returned only for instances that run SQL Server.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'TotalLockTimes' => [ 'description' => 'The total lock duration that was caused by all SQL statements in the query. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'TotalLogicalReadCounts' => [ 'description' => 'The total number of logical reads that were performed by all SQL statements in the query.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'TotalPhysicalReadCounts' => [ 'description' => 'The total number of physical reads that were performed by all SQL statements in the query.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'TotalRowsAffectedCounts' => [ 'description' => 'The total number of rows that were affected by all SQL statements in the query.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], ], ], ], ], ], 'PageNumber' => [ 'description' => 'The number of the page returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageRecordCount' => [ 'description' => 'The number of SQL statements that are returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '2553A660-E4EB-4AF4-A402-8AFF70A49143', ], 'StartTime' => [ 'description' => 'The start date of the query.'."\n", 'type' => 'string', 'example' => '2011-05-30Z', ], 'TotalRecordCount' => [ 'description' => 'The total number of entries that are returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidSearchTimeRange', 'errorMessage' => 'search time range cannot be longer than a month.', ], [ 'errorCode' => 'IO.Exception', 'errorMessage' => 'IO exception, retry later.', ], [ 'errorCode' => 'SortKey.ValueNotSupported', 'errorMessage' => 'SortKey.ValueNotSupported', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 408 => [ [ 'errorCode' => 'RequestTimeout', 'errorMessage' => 'Query timed out.Please try again or narrow down the query scope.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBInstanceId\\": \\"rm-uf6wjk5****\\",\\n \\"EndTime\\": \\"2011-05-30Z\\",\\n \\"Engine\\": \\"SQLServer\\",\\n \\"Items\\": {\\n \\"SQLSlowLog\\": [\\n {\\n \\"AvgExecutionTime\\": 1,\\n \\"AvgIOWriteCounts\\": 0,\\n \\"AvgLastRowsAffectedCounts\\": 0,\\n \\"AvgLogicalReadCounts\\": 0,\\n \\"AvgPhysicalReadCounts\\": 0,\\n \\"AvgRowsAffectedCounts\\": 0,\\n \\"CreateTime\\": \\"2011-05-30Z\\",\\n \\"DBName\\": \\"ceshi\\",\\n \\"MaxExecutionTime\\": 60,\\n \\"MaxExecutionTimeMS\\": 60000,\\n \\"MaxIOWriteCounts\\": 0,\\n \\"MaxLastRowsAffectedCounts\\": 0,\\n \\"MaxLockTime\\": 0,\\n \\"MaxLockTimeMS\\": 1000,\\n \\"MaxLogicalReadCounts\\": 0,\\n \\"MaxPhysicalReadCounts\\": 0,\\n \\"MaxRowsAffectedCounts\\": 0,\\n \\"MinIOWriteCounts\\": 0,\\n \\"MinLastRowsAffectedCounts\\": 0,\\n \\"MinLogicalReadCounts\\": 0,\\n \\"MinPhysicalReadCounts\\": 0,\\n \\"MinRowsAffectedCounts\\": 0,\\n \\"MySQLTotalExecutionCounts\\": 1,\\n \\"MySQLTotalExecutionTimes\\": 1,\\n \\"ParseMaxRowCount\\": 1,\\n \\"ParseTotalRowCounts\\": 1,\\n \\"ReportTime\\": \\"2011-05-30Z\\",\\n \\"ReturnMaxRowCount\\": 1,\\n \\"ReturnTotalRowCounts\\": 1,\\n \\"SQLHASH\\": \\"U2FsdGVk****\\",\\n \\"SQLIdStr\\": \\"521584\\",\\n \\"SQLServerAvgCpuTime\\": 0,\\n \\"SQLServerAvgExecutionTime\\": 0,\\n \\"SQLServerMaxCpuTime\\": 0,\\n \\"SQLServerMinCpuTime\\": 0,\\n \\"SQLServerMinExecutionTime\\": 0,\\n \\"SQLServerTotalCpuTime\\": 0,\\n \\"SQLServerTotalExecutionCounts\\": 1,\\n \\"SQLServerTotalExecutionTimes\\": 1000,\\n \\"SQLText\\": \\"select id,name from tb_table\\",\\n \\"SlowLogId\\": 26584213,\\n \\"TotalIOWriteCounts\\": 0,\\n \\"TotalLastRowsAffectedCounts\\": 0,\\n \\"TotalLockTimes\\": 0,\\n \\"TotalLogicalReadCounts\\": 1,\\n \\"TotalPhysicalReadCounts\\": 1,\\n \\"TotalRowsAffectedCounts\\": 0\\n }\\n ]\\n },\\n \\"PageNumber\\": 1,\\n \\"PageRecordCount\\": 10,\\n \\"RequestId\\": \\"2553A660-E4EB-4AF4-A402-8AFF70A49143\\",\\n \\"StartTime\\": \\"2011-05-01Z\\",\\n \\"TotalRecordCount\\": 5\\n}","errorExample":""},{"type":"xml","example":"\\n 2011-05-30Z\\n 2011-05-30Z\\n 2553A660-E4EB-4AF4-A402-8AFF70A49143\\n 10\\n 5\\n rm-uf6wjk5xxxxxxx\\n 1\\n MySQL\\n \\n 0\\n 1\\n select id,name from tb_table\\n 0\\n 2011-05-30Z\\n 0\\n 0\\n 1\\n 0\\n 1\\n 0\\n U2FsdGVkxxxx\\n 0\\n 1\\n 0\\n 1\\n 1\\n 1\\n 0\\n RDS_MySQL\\n 0\\n 1\\n 1\\n 2011-05-30Z\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 26584213\\n 60\\n 1\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 521584\\n 1000\\n 0\\n 0\\n 0\\n 0\\n \\n","errorExample":""}]', 'title' => 'DescribeSlowLogs', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" ."\n" .' **'."\n" ."\n" .' **Note** This operation is not supported for RDS instances that run MySQL 5.7 on RDS Basic Edition.'."\n" ."\n" .'* SQL Server'."\n" ."\n" .' **'."\n" ."\n" .' **Note** This operation is supported only for RDS instances that run SQL Server 2008 R2.'."\n" ."\n" .'* MariaDB'."\n" ."\n" .'### [](#)Prerequisites'."\n" ."\n" .'* Slow query logs are not collected in real time and may show a latency of 6 to 8 hours.'."\n" .'* If the return result is empty, check whether the StartTime and EndTime parameters are in UTC. If yes, no slow logs are generated within the specified time range.'."\n" .'* Starting from September 01, 2024, the template algorithm for slow queries is optimized. When you call the operation, you must change the value of the **SQLHASH** parameter. For more information, see [\\[Notice\\] Optimization of the template algorithm for slow queries](~~2845725~~).'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeSlowLogRecords' => [ 'summary' => 'Queries the slow log details of an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the instance. You can call the [DescribeDBInstances](~~610396~~) operation to query the ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5******', ], ], [ 'name' => 'SQLHASH', 'in' => 'query', 'schema' => [ 'description' => 'The unique ID of the SQL statement. The ID is used to obtain the slow query logs of the SQL statement.'."\n", 'type' => 'string', 'required' => false, 'example' => 'U2FsdGVk****', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2020-06-17T16:00Z', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => 'The end of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-ddTHH:mm:ssZ* format. The time must be in UTC.**'."\n" ."\n" .'> The end time must be later than the start time.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2020-06-18T16:00Z', ], ], [ 'name' => 'DBName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => false, 'example' => 'RDS_MySQL', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page. Valid value: **30 to 200**. Default value: **30**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '30', 'example' => '30', 'default' => '30', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'default' => '1', ], ], [ 'name' => 'NodeId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the node.'."\n" ."\n" .'> This parameter is available only for instances that run RDS Cluster Edition. You can specify this parameter to query the logs of a specified node. If this parameter is not specified, the logs of the primary node are returned by default.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rn-p1fm78s90x5****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'DBInstanceId' => [ 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5*******', ], 'Engine' => [ 'description' => 'The type of the database engine.'."\n", 'type' => 'string', 'example' => 'MySQL', ], 'Items' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'SQLSlowRecord' => [ 'description' => 'An array that consists of the information about each slow log.'."\n", 'type' => 'array', 'items' => [ 'description' => 'Information about slow query log.'."\n", 'type' => 'object', 'properties' => [ 'ApplicationName' => [ 'description' => 'The name of the application that is connected to the instance.'."\n" ."\n" .'> This parameter is returned only for instances that run SQL Server.'."\n", 'type' => 'string', 'example' => 'example', ], 'ClientHostName' => [ 'description' => 'The hostname of the client.'."\n" ."\n" .'> This parameter is returned only for instances that run SQL Server.'."\n", 'type' => 'string', 'example' => 'example', ], 'CpuTime' => [ 'description' => 'The duration during which the SQL statement is processed by the CPU. Unit: milliseconds.'."\n" ."\n" .'> This parameter is returned only for instances that run SQL Server.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0.002', ], 'DBName' => [ 'description' => 'The name of the database.'."\n", 'type' => 'string', 'example' => 'testDB', ], 'ExecutionStartTime' => [ 'description' => 'The time when the execution of the SQL statement started. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2020-06-18T01:40:44Z', ], 'HostAddress' => [ 'description' => 'The name and IP address of the client that is connected to the database.'."\n", 'type' => 'string', 'example' => 'xxx[xxx] @ [1xx.xxx.xxx.xx]', ], 'LastRowsAffectedCount' => [ 'description' => 'The number of rows that are affected by the last SQL statement.'."\n" ."\n" .'> This parameter is returned only for instances that run SQL Server.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2', ], 'LockTimes' => [ 'description' => 'The lock duration of the query. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'LogicalIORead' => [ 'description' => 'The number of logical reads.'."\n" ."\n" .'> This parameter is returned only for instances that run SQL Server.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '383', ], 'ParseRowCounts' => [ 'description' => 'The number of parsed rows.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'PhysicalIORead' => [ 'description' => 'The number of physical reads.'."\n" ."\n" .'> This parameter is returned only for instances that run SQL Server.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'QueryTimeMS' => [ 'description' => 'The execution duration of the query. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2001', ], 'QueryTimes' => [ 'description' => 'The execution duration of the query. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2', ], 'ReturnRowCounts' => [ 'description' => 'The number of rows returned.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'RowsAffectedCount' => [ 'description' => 'The number of affected rows.'."\n" ."\n" .'> This parameter is returned only for instances that run SQL Server.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '34', ], 'SQLHash' => [ 'description' => 'The unique ID of the SQL statement.'."\n", 'type' => 'string', 'example' => 'U2FsdGVk****', ], 'SQLText' => [ 'description' => 'The details of the SQL statement.'."\n", 'type' => 'string', 'example' => 'select sleep(2)', ], 'UserName' => [ 'description' => 'The name of the user.'."\n" ."\n" .'> This parameter is returned only for instances that run SQL Server.'."\n", 'type' => 'string', 'example' => 'user', ], 'WriteIOCount' => [ 'description' => 'The number of I/O writes.'."\n" ."\n" .'> This parameter is returned only for instances that run SQL Server.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '22', ], 'LockTimeMS' => [ 'type' => 'integer', 'format' => 'int64', ], ], ], ], ], ], 'PageNumber' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageRecordCount' => [ 'description' => 'The number of SQL log reports on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '4DBB1BB0-E5D8-4D41-B1C9-142364DB****', ], 'TotalRecordCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidSearchTimeRange', 'errorMessage' => 'search time range cannot be longer than a month.', ], [ 'errorCode' => 'IO.Exception', 'errorMessage' => 'IO exception, retry later.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 408 => [ [ 'errorCode' => 'RequestTimeout', 'errorMessage' => 'Query timed out.Please try again or narrow down the query scope.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBInstanceId\\": \\"rm-uf6wjk5****\\",\\n \\"Engine\\": \\"MySQL\\",\\n \\"Items\\": {\\n \\"SQLSlowRecord\\": [\\n {\\n \\"ApplicationName\\": \\"example\\",\\n \\"ClientHostName\\": \\"example\\",\\n \\"CpuTime\\": 0.002,\\n \\"DBName\\": \\"testDB\\",\\n \\"ExecutionStartTime\\": \\"2020-06-18T01:40:44Z\\",\\n \\"HostAddress\\": \\"****[****] @ [1XX.XX.XX.XX]\\",\\n \\"LastRowsAffectedCount\\": 2,\\n \\"LockTimes\\": 0,\\n \\"LogicalIORead\\": 383,\\n \\"ParseRowCounts\\": 1,\\n \\"PhysicalIORead\\": 200,\\n \\"QueryTimeMS\\": 2001,\\n \\"QueryTimes\\": 2,\\n \\"ReturnRowCounts\\": 1,\\n \\"RowsAffectedCount\\": 34,\\n \\"SQLHash\\": \\"U2FsdGVk****\\",\\n \\"SQLText\\": \\"select sleep(2)\\",\\n \\"UserName\\": \\"user\\",\\n \\"WriteIOCount\\": 22,\\n \\"LockTimeMS\\": 0\\n }\\n ]\\n },\\n \\"PageNumber\\": 1,\\n \\"PageRecordCount\\": 1,\\n \\"RequestId\\": \\"4DBB1BB0-E5D8-4D41-B1C9-142364DB****\\",\\n \\"TotalRecordCount\\": 1\\n}","errorExample":""},{"type":"xml","example":"\\n 1\\n 4DBB1BB0-E5D8-4D41-B1C9-142364DB****\\n 1\\n rm-uf6wjk5*******\\n MySQL\\n 1\\n \\n xxx[xxx] @ [1xx.xxx.xxx.xx]\\n 34\\n 2\\n select sleep(2)\\n 2001\\n example\\n 0\\n 2020-06-18T01:40:44Z\\n 383\\n 22\\n 200\\n 1\\n 1\\n testDB\\n example\\n user\\n 2\\n U2FsdGVk****\\n \\n","errorExample":""}]', 'title' => 'DescribeSlowLogRecords', 'description' => '### Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" .'* MariaDB'."\n" ."\n" .'### Precautions'."\n" ."\n" .'The response parameters returned by this operation are updated every minute.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeErrorLogs' => [ 'summary' => 'Queries the error logs of an instance over a specific time range.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5xxxxxxx', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2011-05-01T20:10Z', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => 'The end of the time range to query. The end time must be later than the start time. The time span between the start time and the end time must be less than 31 days. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2011-05-30T20:10Z', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page. Valid values: **30** to **100**. Default value: **30**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '30', 'example' => '30', 'default' => '30', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => 'The page number. Pages start from page 1.'."\n" ."\n" .'Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'default' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Items' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'ErrorLog' => [ 'description' => 'Details about the log entries returned.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'CreateTime' => [ 'description' => 'The time when the error log entry was generated. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2011-05-30T12:11:04Z', ], 'ErrorInfo' => [ 'description' => 'The error log information.'."\n", 'type' => 'string', 'example' => 'spid52 DBCC TRACEON 3499, server process ID (SPID) 52. This is an informational message only; no user action is required', ], 'UserIp' => [ 'type' => 'string', ], 'Database' => [ 'type' => 'string', ], 'User' => [ 'type' => 'string', ], ], ], ], ], ], 'PageNumber' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageRecordCount' => [ 'description' => 'The number of error logs on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '98504E07-BB0E-40FC-B152-E4882615812C', ], 'TotalRecordCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidSearchTimeRange', 'errorMessage' => 'search time range cannot be longer than a month.', ], [ 'errorCode' => 'IO.Exception', 'errorMessage' => 'IO exception, retry later.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 408 => [ [ 'errorCode' => 'RequestTimeout', 'errorMessage' => 'Query timed out.Please try again or narrow down the query scope.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Items\\": {\\n \\"ErrorLog\\": [\\n {\\n \\"CreateTime\\": \\"2011-05-30T12:11:04Z\\",\\n \\"ErrorInfo\\": \\"spid52 DBCC TRACEON 3499, server process ID (SPID) 52. This is an informational message only; no user action is required\\",\\n \\"UserIp\\": \\"xx.xx.xx.xx\\",\\n \\"Database\\": \\"test_db\\",\\n \\"User\\": \\"test_user\\"\\n }\\n ]\\n },\\n \\"PageNumber\\": 1,\\n \\"PageRecordCount\\": 30,\\n \\"RequestId\\": \\"98504E07-BB0E-40FC-B152-E4882615812C\\",\\n \\"TotalRecordCount\\": 100\\n}","errorExample":"{\\n \\"RequestId\\": \\"7463B73D-35CC-4D19-A010-6B8D65D242EF\\",\\n \\"HostId\\": \\"rds.aliyuncs.com\\",\\n \\"Code\\": \\"UnsupportedOperation\\",\\n \\"Message\\": \\"The specified action is not supported.\\"\\n}"},{"type":"xml","example":"\\n\\n\\t98504E07-BB0E-40FC-B152-E4882615812C\\n\\t1\\n\\t1\\n\\t1\\n\\t\\n\\t\\t\\n\\t\\t\\tspid52 DBCC TRACEON 3499, server process ID (SPID) 52. This is an informational message only; no user action is required\\n\\t\\t\\t2013-06-04T15:00:00\\n\\t\\t\\n \\n\\n\\t\\n","errorExample":""}]', 'title' => 'DescribeErrorLogs', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" .'* MariaDB'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ModifySQLCollectorPolicy' => [ 'summary' => 'This operation can still be called but is no longer maintained. This operation enables or disables the SQL Explorer (SQL Audit) feature for an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5xxxxxxx', ], ], [ 'name' => 'SQLCollectorStatus', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable the SQL Explorer (SQL Audit) feature. Valid values:'."\n" ."\n" .'* **Enable**'."\n" .'* **Disabled**'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'enumValueTitles' => [], 'example' => 'Enable', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The resource group ID. You can call theDescribeDBInstanceAttribute operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmx**********', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidSqlLog.Malformed', 'errorMessage' => 'The specified parameter SqlLog is not valid.', ], [ 'errorCode' => 'InvalidConfigName', 'errorMessage' => 'The ConfigName is not valid.', ], [ 'errorCode' => 'InvalidConfigValue', 'errorMessage' => 'The ConfigValue is not valid.', ], [ 'errorCode' => 'IncorrectPerfFrequencyType', 'errorMessage' => 'Current DB instance does not support this perf frequency.', ], [ 'errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'Specified parameter is not valid', ], [ 'errorCode' => 'ErrorMxsServiceInsNum.Error', 'errorMessage' => 'The Maxscale serviceIns num must be 1.', ], [ 'errorCode' => 'IncorrectSQLLogVersion', 'errorMessage' => 'Current DB instance SQL log version does not support this operation.', ], [ 'errorCode' => 'IncorrectSQLLogActiveStatus', 'errorMessage' => 'Current DB instance SQL log active status does not support this operation.', ], [ 'errorCode' => 'OperationDenied.QuotaInsufficient', 'errorMessage' => 'The DAS Enterprise Edition (V1) quota is insufficient.', ], [ 'errorCode' => 'OperationDenied.OperateFrequently', 'errorMessage' => 'The modification operation is too frequent.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'INSUFFICIENT_AVAILABLE_QUOTA', 'errorMessage' => 'Your account available limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', ], [ 'errorCode' => 'IncorrectDBType', 'errorMessage' => 'The current DB type does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstanceCharacterType', 'errorMessage' => 'Current DB Instance character_type does not support this operation.', ], [ 'errorCode' => 'InvalidSqlRetention.Malformed', 'errorMessage' => 'Specified sql retention is not valid.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], 504 => [ [ 'errorCode' => 'OperationDenied.Timeout', 'errorMessage' => 'The request processing has failed due to timeout.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","errorExample":""},{"type":"xml","example":"\\n\\n\\tC3565F9F-76E9-4F7E-A662-D1B2488EC2FC\\n\\n\\t\\n","errorExample":""}]', 'title' => 'ModifySQLCollectorPolicy', 'description' => 'This operation can still be called but is no longer maintained. We recommend that you call the [ModifySqlLogConfig](~~2778835~~) operation instead of this operation.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ModifySQLCollectorRetention' => [ 'summary' => 'Changes the retention period of the log files that are generated by the SQL Explorer feature for an ApsaraDB RDS instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5xxxxxxx', ], ], [ 'name' => 'ConfigValue', 'in' => 'query', 'schema' => [ 'description' => 'The log retention period that is allowed by the SQL Explorer feature on the instance. Valid values:'."\n" ."\n" .'* 30: 30 days'."\n" .'* 180: 180 days'."\n" .'* 365: one year'."\n" .'* 1095: three years'."\n" .'* 1825: five years'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '365', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The resource group ID. You can call the DescribeDBInstanceAttribute operation to obtain the resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmyxxxx', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '21383BB3-3845-4628-B422-B4FB5C83DEBD', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidConfigValue', 'errorMessage' => 'The ConfigValue is not valid.', ], [ 'errorCode' => 'IncorrectSQLLogActiveStatus', 'errorMessage' => 'Current DB instance SQL log active status does not support this operation.', ], [ 'errorCode' => 'InvalidSqlRetention.Malformed', 'errorMessage' => 'Specified sql retention is not valid.', ], [ 'errorCode' => 'IncorrectSQLLogVersion', 'errorMessage' => 'Current DB instance SQL log version does not support this operation.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"21383BB3-3845-4628-B422-B4FB5C83DEBD\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 21383BB3-3845-4628-B422-B4FB5C83DEBD\\n","errorExample":""}]', 'title' => 'ModifySQLCollectorRetention', 'description' => '### Supported database engines'."\n" ."\n" .'RDS MySQL'."\n" ."\n" .'### Precautions'."\n" ."\n" .'After you shorten the log backup retention period, log backup files that are stored longer than the specified log backup retention period are immediately deleted.'."\n" ."\n" .'### References'."\n" ."\n" .'> : Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.'."\n" ."\n" .'[Use the SQL Explorer and Audit feature](~~476574~~)'."\n", ], 'DescribeSQLCollectorPolicy' => [ 'summary' => 'Queries the status of the SQL Explorer (SQL Audit) feature for an ApsaraDB RDS instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxxxxx', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5xxxxxxx', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The resource group ID. You can call the DescribeDBInstanceAttribute operation to query the resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmyxxxxxxxxxx', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', ], 'SQLCollectorStatus' => [ 'description' => 'The status of the SQL Explorer (SQL Audit) feature. Valid values:'."\n" ."\n" .'* **Enable**'."\n" .'* **Disabled**'."\n", 'type' => 'string', 'example' => 'Enable', ], 'StoragePeriod' => [ 'description' => 'A reserved parameter.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], 504 => [ [ 'errorCode' => 'OperationDenied.Timeout', 'errorMessage' => 'The request processing has failed due to timeout.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"SQLCollectorStatus\\": \\"Enable\\",\\n \\"StoragePeriod\\": 0\\n}","errorExample":"{\\n \\"RequestId\\": \\"7463B73D-35CC-4D19-A010-6B8D65D242EF\\",\\n \\"HostId\\": \\"rds.aliyuncs.com\\",\\n \\"Code\\": \\"UnsupportedOperation\\",\\n \\"Message\\": \\"The specified action is not supported.\\"\\n}"},{"type":"xml","example":"\\n\\n\\tC3565F9F-76E9-4F7E-A662-D1B2488EC2FC\\n\\tEnable\\n\\t\\n","errorExample":""}]', 'title' => 'DescribeSQLCollectorPolicy', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeSQLLogRecords' => [ 'summary' => 'Queries the logs that are generated by the SQL Explorer (SQL Audit) feature for an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the generated token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxx', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5xxxxxxx', ], ], [ 'name' => 'SQLId', 'in' => 'query', 'schema' => [ 'description' => 'The unique ID of the SQL statement.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '25623548', ], ], [ 'name' => 'QueryKeywords', 'in' => 'query', 'schema' => [ 'description' => 'The keyword that is used for the query.'."\n" ."\n" .'* When you call this operation and set the **Form** parameter to **File** to generate an audit file, you cannot filter log entries by keyword.'."\n" .'* You can specify up to 10 keywords. The keywords are evaluated by using the **AND** operator. Separate multiple keywords with spaces.'."\n" .'* If a field name in the specified SQL statement is enclosed in grave accents (\\`) and you want to use the field name as a keyword, you must enter the grave accents (\\`) as part of the field name. For example, if the field name is \\`id\\`, enter \\`id\\` instead of id.'."\n" ."\n" .'> After you enter a keyword, the system matches the keyword based on the **Database**, **User**, and **QueryKeywords** parameters. The parameters are evaluated by using the **AND** operator.'."\n", 'type' => 'string', 'required' => false, 'example' => 'table_name', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => 'The beginning of the time range to query. You can query data in the last 15 days before the current date. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2011-06-01T15:00:00Z', ], ], [ 'name' => 'Database', 'in' => 'query', 'schema' => [ 'description' => 'The name of the database. You can enter only one database name. If you specify this parameter, this operation returns the logs that are generated only for the specified database. If you do not specify this parameter, this operation returns the logs that are generated for all databases on the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Database', ], ], [ 'name' => 'User', 'in' => 'query', 'schema' => [ 'description' => 'The username of the account. You can enter only one username. If you specify this parameter, this operation returns the logs that are generated only for the specified account. If you do not specify this parameter, this operation returns the logs that are generated for all accounts on the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'user', ], ], [ 'name' => 'Form', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to generate an SQL audit log file or return SQL audit logs. Valid values:'."\n" ."\n" .'* **File**: If you set this parameter to File, this operation generates an SQL audit log file and returns only common response parameters. After you call this operation, you must call the DescribeSQLLogFiles operation to obtain the download URL of the SQL audit log file.'."\n" .'* **Stream** (default): If you set this parameter to Stream, this operation returns SQL audit logs.'."\n" ."\n" .'> If you set this parameter to **File**, only ApsaraDB RDS for MySQL instances that use local disks and ApsaraDB RDS for SQL Server instances are supported, and a maximum of 1 million logs are returned.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Stream', 'default' => 'Stream', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => 'The end of the time range to query. The end time must be later than the start time. The time span between the start time and the end time must be less than 15 days. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2011-06-11T15:00:00Z', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page. Valid values: **30** to **100**. Default value: **30**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '200', 'minimum' => '30', 'example' => '30', 'default' => '100', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => 'The page number. Pages start from 1.'."\n" ."\n" .'Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'default' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Items' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'SQLRecord' => [ 'description' => 'The details about each SQL audit log entry.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'AccountName' => [ 'description' => 'The username of the account that is recorded in the SQL audit log entry.'."\n", 'type' => 'string', 'example' => 'accounttest', ], 'DBName' => [ 'description' => 'The database name.'."\n", 'type' => 'string', 'example' => 'testDB', ], 'ExecuteTime' => [ 'description' => 'The time at which the SQL statement was executed. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2011-06-11T15:00:23Z', ], 'HostAddress' => [ 'description' => 'The IP address of the client that is connected to the instance.'."\n", 'type' => 'string', 'example' => '192.168.0.121', ], 'ReturnRowCounts' => [ 'description' => 'The number of SQL audit log entries that are returned.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '30', ], 'SQLText' => [ 'description' => 'The SQL statement.'."\n", 'type' => 'string', 'example' => 'update test.zxb set id=0 limit 1', ], 'ThreadID' => [ 'description' => 'The thread ID.'."\n", 'type' => 'string', 'example' => '1025865428', ], 'TotalExecutionTimes' => [ 'description' => 'The execution duration of the SQL statement. Unit: microseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '600', ], ], ], ], ], ], 'PageNumber' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageRecordCount' => [ 'description' => 'The number of SQL audit log entries on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '08A3B71B-FE08-4B03-974F-CC7EA6DB1828', ], 'TotalRecordCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '100', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidQueryTimeRange', 'errorMessage' => 'The query time range is invalid.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], 504 => [ [ 'errorCode' => 'OperationDenied.Timeout', 'errorMessage' => 'The request processing has failed due to timeout.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Items\\": {\\n \\"SQLRecord\\": [\\n {\\n \\"AccountName\\": \\"accounttest\\",\\n \\"DBName\\": \\"testDB\\",\\n \\"ExecuteTime\\": \\"2011-06-11T15:00:23Z\\",\\n \\"HostAddress\\": \\"192.168.XX.XX\\",\\n \\"ReturnRowCounts\\": 30,\\n \\"SQLText\\": \\"update test.zxb set id=0 limit 1\\",\\n \\"ThreadID\\": \\"1025865428\\",\\n \\"TotalExecutionTimes\\": 600\\n }\\n ]\\n },\\n \\"PageNumber\\": 1,\\n \\"PageRecordCount\\": 30,\\n \\"RequestId\\": \\"08A3B71B-FE08-4B03-974F-CC7EA6DB1828\\",\\n \\"TotalRecordCount\\": 100\\n}","errorExample":"{\\n \\"RequestId\\": \\"7463B73D-35CC-4D19-A010-6B8D65D242EF\\",\\n \\"HostId\\": \\"rds.aliyuncs.com\\",\\n \\"Code\\": \\"UnsupportedOperation\\",\\n \\"Message\\": \\"The specified action is not supported.\\"\\n}"},{"type":"xml","example":"\\n\\n\\t1\\n\\t1\\n\\t1\\n\\t\\n\\t\\t\\n\\t\\t\\ttest\\n\\t\\t\\taccounttest\\n\\t\\t\\t192.168.0.121\\n\\t\\t\\tupdate test.zxb set id=0 limit 1\\n\\t\\t\\t12\\n\\t\\t\\t34\\n\\t\\t\\t2011-06-11T15:00:23Z\\n\\t\\t\\n\\t\\n\\t08A3B71B-FE08-4B03-974F-CC7EA6DB1828\\n\\n\\t\\n","errorExample":""}]', 'title' => 'DescribeSQLLogRecords', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" ."\n" .'### [Usage notes](#)'."\n" ."\n" .'* You can call this operation up to 1,000 times per minute per account. The calls initiated by using both your Alibaba Cloud account and RAM users within your Alibaba Cloud account are counted.'."\n" .'* This operation cannot be used to query the logs that are generated by SQL Explorer Trial Edition for an ApsaraDB RDS for MySQL instance.'."\n" .'* When you call this operation and set the **Form** parameter to **File** to generate an audit file, a maximum of 1 million log entries can be recorded in the audit file, and you cannot filter log entries by keyword.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeSQLCollectorRetention' => [ 'summary' => 'Queries the retention period of the log files that are generated by the SQL Explorer feature for an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5xxxxxxx', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The resource group ID. You can call the DescribeDBInstanceAttribute operation to query the resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmyxxxx', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'ConfigValue' => [ 'description' => 'The retention period of the log files that are generated by the SQL Explorer feature. Valid values:'."\n" ."\n" .'* **30:** 30 days'."\n" .'* **180:** 180 days'."\n" .'* **365**: one year'."\n" .'* **1095**: three years'."\n" .'* **1825**: five years'."\n" ."\n" .'> The retention period of the log files that are generated by the SQL Explorer feature on ApsaraDB RDS for PostgreSQL instances and ApsaraDB RDS for SQL Server instances is fixed as 30 days.'."\n", 'type' => 'string', 'example' => '365', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'D5CEDCC2-CA75-43F7-9508-92F418CE6391', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidComment', 'errorMessage' => 'Should specify a policy name.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"ConfigValue\\": \\"365\\",\\n \\"RequestId\\": \\"D5CEDCC2-CA75-43F7-9508-92F418CE6391\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 365\\n D5CEDCC2-CA75-43F7-9508-92F418CE6391\\n","errorExample":""}]', 'title' => 'DescribeSQLCollectorRetention', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ModifyBackupSetExpireTime' => [ 'summary' => 'Extends the expiration time of backup sets generated by manual backup for a single database, including physical backup sets and full backup sets.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5****', ], ], [ 'name' => 'BackupId', 'in' => 'query', 'schema' => [ 'description' => 'The backup set ID. You can call the DescribeBackups operation to query the backup set ID. The backup set must meet the following requirements:'."\n" ."\n" .'* The Engine parameter is SQLServer'."\n" .'* The BackupMode parameter is set to Manual.'."\n" .'* The BackupMethod parameter is set to Physical.'."\n" .'* The BackupType parameter is set to FullBackup.'."\n" .'* The BackupStatus parameter is set to Success.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => 'b-n8tpg24c6i0v****', ], ], [ 'name' => 'ExpectExpireTime', 'in' => 'query', 'schema' => [ 'description' => 'The point in time to which you want to extend the expiration time of the backup set. Specify the time in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.'."\n" ."\n" .'The time cannot be earlier than the current expiration time. You can call the DescribeBackups operation to view the current expiration time of the backup set.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2025-06-17T12:10:23Z', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '76364A52-E0AB-5CC8-9818-CF1DC482C092', ], 'Message' => [ 'description' => 'The information about the status code.'."\n", 'type' => 'string', 'example' => 'success', ], 'Code' => [ 'description' => 'The status code.'."\n", 'type' => 'string', 'example' => '200', ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**: The request was successful.'."\n" .'* **false**: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Data' => [ 'description' => 'The details of the returned parameters.'."\n", 'type' => 'string', 'example' => '{'."\n" .' "SupportOnlineResizeDisk": true,'."\n" .' "DBInstanceName": "rm-bp****",'."\n" .' "maxSupportDiskSizeGB": 6144'."\n" .'}', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidExpectExpireTime.Format', 'errorMessage' => 'The specified param ExpectExpireTime is not valid.', ], [ 'errorCode' => 'DBS.ParamIsInValid', 'errorMessage' => '%s.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'NoAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for account. We recommend that you add a payment method.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidBackupId.NotFound', 'errorMessage' => 'The BackupId provided does not exist.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"76364A52-E0AB-5CC8-9818-CF1DC482C092\\",\\n \\"Message\\": \\"success\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true,\\n \\"Data\\": \\"{expectExpireTime=1752581423000, dbClusterId=rm-7xv8f2zcia0e4****, backupId=262186****}\\"\\n}","type":"json"}]', 'title' => 'ModifyBackupSetExpireTime', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'RDS SQL Server'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> Before you call this operation, read the following topics and make sure that you fully understand the prerequisites and impacts of this operation.'."\n" ."\n" .'[Manually back up the data of an RDS for SQL Server instance](~~95717~~)'."\n", ], 'CreateBackup' => [ 'summary' => 'Creates a backup file for an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5****', ], ], [ 'name' => 'DBName', 'in' => 'query', 'schema' => [ 'description' => 'The names of the databases whose data you want to back up. Separate the names of the databases with commas (,).'."\n" ."\n" .'> You can specify this parameter when you perform a logical backup on individual databases of an ApsaraDB RDS for MySQL instance. You can also specify this parameter when you perform a full physical backup on individual databases of an ApsaraDB RDS for SQL Server instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rds_mysql', ], ], [ 'name' => 'BackupStrategy', 'in' => 'query', 'schema' => [ 'description' => 'The backup policy. Valid values:'."\n" ."\n" .'* **db**: a database-level backup.'."\n" .'* **instance**: an instance-level backup.'."\n" ."\n" .'> You can specify this parameter when you perform a logical backup on an ApsaraDB RDS for MySQL instance. You can also specify this parameter when you perform a full physical backup on an ApsaraDB RDS for SQL Server instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'db', ], ], [ 'name' => 'BackupMethod', 'in' => 'query', 'schema' => [ 'description' => 'The backup type of the instance. Valid values:'."\n" ."\n" .'* **Logical**: logical backup'."\n" .'* **Physical**: physical backup'."\n" .'* **Snapshot**: snapshot backup'."\n" ."\n" .'Default value: **Physical**.'."\n" ."\n" .'> * You can perform a logical backup only when databases are created on the instance.'."\n" .'> * When you perform a snapshot backup on an ApsaraDB RDS for MariaDB instance, you must set this parameter to **Physical**.'."\n" .'> * For more information about the supported backup types, see [Use the data backup feature](~~98818~~).'."\n" .'> * When you perform a snapshot backup on an ApsaraDB RDS for SQL Server instance that uses cloud disks, you must set this parameter to **Snapshot**.', 'type' => 'string', 'required' => false, 'example' => 'Physical', ], ], [ 'name' => 'BackupType', 'in' => 'query', 'schema' => [ 'description' => 'The backup method. Valid values:'."\n" ."\n" .'* **Auto**: full or incremental backup that is automatically selected'."\n" .'* **FullBackup**: full backup'."\n" ."\n" .'Default value: **Auto**.'."\n" ."\n" .'> * You must set this parameter only when the instance runs SQL Server.'."\n" .'> * This parameter is valid only when you set the **BackupMethod** parameter to **Physical**.', 'type' => 'string', 'required' => false, 'example' => 'Auto', ], ], [ 'name' => 'BackupRetentionPeriod', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int64', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'BackupJobId' => [ 'description' => 'The ID of the backup task.'."\n", 'type' => 'string', 'example' => '5073731', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '2C125605-266F-41CA-8AC5-3A643D4F42C5', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'BackupType.NotSupport', 'errorMessage' => 'the specified backup type not support', ], [ 'errorCode' => 'InvalidBackupMethod.ValueNotSupport', 'errorMessage' => 'The specified parameter "BackupMethod" is not valid.', ], [ 'errorCode' => 'ReadDBInstanceNotSupport', 'errorMessage' => 'The operation is not permitted due to type of the instance.', ], [ 'errorCode' => 'IncorrectDBInstanceLockMode.ValueNotSupported', 'errorMessage' => 'The Current DB instance lock mode does not support this operation.', ], [ 'errorCode' => 'BackupJobExists', 'errorMessage' => 'A backup job already exists in the specified DB instance.', ], [ 'errorCode' => 'InvalidPreferredBackupTime.Format', 'errorMessage' => 'Specified preferred backup time is not valid.', ], [ 'errorCode' => 'InvalidDBName.Format', 'errorMessage' => 'Specified DB name is not valid.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OperationDenied.ApiForbidden', 'errorMessage' => 'operation not permitted.', ], [ 'errorCode' => 'IncorrectDBInstanceEngine', 'errorMessage' => 'Current DB Instance engine does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance engine and type does not support operations.', ], [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstanceCharacterType', 'errorMessage' => 'Current DB Instance character_type does not support this operation.', ], [ 'errorCode' => 'Exceeded.BackupTimes', 'errorMessage' => 'The backup times exceeds.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', ], [ 'errorCode' => 'InvalidDB.NotFound', 'errorMessage' => 'Specified db does not exist or DB status does not support this operation.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"BackupJobId\\": \\"507****\\",\\n \\"RequestId\\": \\"2C125605-266F-41CA-8AC5-3A643D4F42C5\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"7463B73D-35CC-4D19-A010-6B8D65D242EF\\",\\n \\"HostId\\": \\"rds.aliyuncs.com\\",\\n \\"Code\\": \\"UnsupportedOperation\\",\\n \\"Message\\": \\"The specified action is not supported.\\"\\n}"},{"type":"xml","example":"\\n\\n\\t2C125605-266F-41CA-8AC5-3A643D4F42C5\\n\\t5073731\\n","errorExample":""}]', 'title' => 'CreateBackup', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" .'* MariaDB'."\n" ."\n" .'### [](#)Feature description'."\n" ."\n" .'This operation uses the backup feature of ApsaraDB RDS to create a backup set. You can also call an operation of Database Backup (DBS) to create a backup set. For more information, see [List of operations by function](~~2402073~~).'."\n" ."\n" .'### [](#)Prerequisites'."\n" ."\n" .'Before you call this operation, make sure that the following requirements are met:'."\n" ."\n" .'* The instance is in the Running state.'."\n" .'* The instance does not have ongoing backup tasks.'."\n" .'* The number of backup sets that can be created for an instance per day cannot exceed 20.'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'* [Use the data backup feature for an ApsaraDB RDS for MySQL instance](~~378074~~)'."\n" .'* [Use the data backup feature for an ApsaraDB RDS for PostgreSQL instance](~~96772~~)'."\n" .'* [Use the data backup feature for an ApsaraDB RDS for SQL Server instance](~~95717~~)'."\n" .'* [Use the data backup feature for an ApsaraDB RDS for MariaDB instance](~~97147~~)', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DeleteBackup' => [ 'summary' => 'Deletes the data backup files of an ApsaraDB RDS instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-uf6wjk5xxxxxxx', ], ], [ 'name' => 'BackupId', 'in' => 'query', 'schema' => [ 'description' => 'The backup set ID. You can call the DescribeBackups operation to query the backup set ID. Separate multiple values with commas (,). You can specify a maximum of 100 values in a single request.'."\n" ."\n" .'> You can delete only backup sets whose **StoreStatus** is **Enabled** in the response to the DescribeBackups operation call.'."\n", 'type' => 'string', 'required' => true, 'example' => '324******', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '37441409-FFD1-40AA-8EC5-9ECF5E2F7C29', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'ReadDBInstanceNotSupport', 'errorMessage' => 'The operation is not permitted due to type of the instance.', ], [ 'errorCode' => 'ParameterLeastAssociate', 'errorMessage' => 'Must input at least one optional parameter', ], [ 'errorCode' => 'DeleteBackupSetNumExceed', 'errorMessage' => 'Delete backup set number is more than 100.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance engine and type does not support operations.', ], [ 'errorCode' => 'IncorrectDBInstanceCharacterType', 'errorMessage' => 'Current DB Instance character_type does not support this operation.', ], [ 'errorCode' => 'OperationDenied.BackupSetDeleteNotSupport', 'errorMessage' => 'The Specified backup does not support this operation.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'Invalid DBInstanceId NotFound.', ], [ 'errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', ], [ 'errorCode' => 'InvalidBackupSetID.NotFound', 'errorMessage' => 'Specified backup set ID does not exist.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"37441409-FFD1-40AA-8EC5-9ECF5E2F7C29\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"7463B73D-35CC-4D19-A010-6B8D65D242EF\\",\\n \\"HostId\\": \\"rds.aliyuncs.com\\",\\n \\"Code\\": \\"UnsupportedOperation\\",\\n \\"Message\\": \\"The specified action is not supported.\\"\\n}"},{"type":"xml","example":"\\n\\n\\t37441409-FFD1-40AA-8EC5-9ECF5E2F7C29\\n\\n\\t\\n","errorExample":""}]', 'title' => 'DeleteBackup', 'description' => '### Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" ."\n" .'> Only instances that run RDS High-availability Edition are supported.'."\n" ."\n" .'### Description'."\n" ."\n" .'You can call this operation to delete backup sets of the instance itself. Backup sets of the associated instances such as read-only, disaster recovery, and cloned instances are not deleted.'."\n" ."\n" .'### Precautions'."\n" ."\n" .'Before you call this operation, make sure that the following requirements are met:'."\n" ."\n" .'* The instance is in the Running state.'."\n" .'* If the log backup feature is disabled, instances cannot be restored by point in time. You can delete data backup sets that are retained for more than seven days.'."\n" .'* If the log backup feature is enabled and the log backup retention period is shorter than the data backup retention period, you can delete the data backup files that are retained for a period longer than the log backup retention period.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DeleteBackupFile' => [ 'summary' => 'Deletes the backup files of an ApsaraDB RDS for SQL Server instance. This operation is available only for users that have been added to the whitelist of the instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'delete', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the DescribeDBInstanceAttribute operation to query the region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-bp6wjk5******', ], ], [ 'name' => 'BackupId', 'in' => 'query', 'schema' => [ 'description' => 'You can specify only the ID of a backup file whose backup policy is Single-database Backup. You can specify the IDs of up to 100 backup files at a time. Separate the IDs with commas (,). You can call the DescribeBackups operation to query the IDs of data backup files.'."\n", 'type' => 'string', 'required' => false, 'example' => '29304****', ], ], [ 'name' => 'DBName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testdb', ], ], [ 'name' => 'BackupTime', 'in' => 'query', 'schema' => [ 'description' => 'The time before which the backup files you want to delete are generated. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => false, 'example' => '2011-06-11T16:00:00Z', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'DeletedBaksetIds' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'DeletedBaksetIds' => [ 'description' => 'An array that consists of the IDs of deleted backup sets.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The ID of the backup set.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '29304****', ], ], ], ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'C7B3A91C-0ACD-4948-ACAE-xxxxxxxD4069', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidBakset.Invalid', 'errorMessage' => 'Specified bakset is not valid.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidBackupSetID.NotFound', 'errorMessage' => 'Specified backup set ID does not exist.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"DeletedBaksetIds\\": {\\n \\"DeletedBaksetIds\\": [\\n 0\\n ]\\n },\\n \\"RequestId\\": \\"C7B3A91C-0ACD-4948-ACAE-****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n C7B3A91C-0ACD-4948-ACAE-xxxxxxxD4069\\n","errorExample":""}]', 'title' => 'DeleteBackupFile', 'description' => '### [](#)Supported database engine'."\n" ."\n" .'SQL Server'."\n" ."\n" .'> **This operation is not supported for new users. **Select other methods to [reduce or save backup costs](~~95718~~). Users who are added to the whitelist can still use the backup file. Check the availability of the backup file before you delete it. After the backup file is deleted, you cannot retrieve it.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ModifyBackupPolicy' => [ 'summary' => 'Modifies the backup policy settings of an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5xxxxxxx', ], ], [ 'name' => 'BackupPolicyMode', 'in' => 'query', 'schema' => [ 'description' => 'The type of the backup. Valid values:'."\n" ."\n" .'* **DataBackupPolicy**: data backup'."\n" .'* **LogBackupPolicy**: log backup'."\n", 'type' => 'string', 'required' => false, 'example' => 'DataBackupPolicy', ], ], [ 'name' => 'PreferredBackupTime', 'in' => 'query', 'schema' => [ 'description' => 'The time at which you want to perform a backup. Specify the time in the ISO 8601 standard in the *HH:mm*Z-*HH:mm*Z format. The time must be in UTC.'."\n" ."\n" .'> * This parameter must be specified when **BackupPolicyMode** is set to **DataBackupPolicy**.'."\n" .'> * This parameter takes effect only when **BackupPolicyMode** is set to **DataBackupPolicy**.', 'type' => 'string', 'required' => false, 'example' => '00:00Z-01:00Z', ], ], [ 'name' => 'PreferredBackupPeriod', 'in' => 'query', 'schema' => [ 'description' => 'The backup cycle. Specify at least two days of the week and separate the days with commas (,). Valid values:'."\n" ."\n" .'* **Monday**'."\n" .'* **Tuesday**'."\n" .'* **Wednesday**'."\n" .'* **Thursday**'."\n" .'* **Friday**'."\n" .'* **Saturday**'."\n" .'* **Sunday**'."\n" ."\n" .'> * You can configure a backup policy by using this parameter and the **BackupInterval** parameter. For example, if you set this parameter to Saturday,Sunday and the **BackupInterval** parameter to 30, a backup is performed every 30 minutes on every Saturday and Sunday.'."\n" .'> * This parameter must be specified when **BackupPolicyMode** is set to **DataBackupPolicy**.'."\n" .'> * This parameter takes effect only when **BackupPolicyMode** is set to **DataBackupPolicy**.', 'type' => 'string', 'required' => false, 'example' => 'Monday', ], ], [ 'name' => 'BackupRetentionPeriod', 'in' => 'query', 'schema' => [ 'description' => 'The number of days for which you want to retain data backup files. Valid values: **7 to 730**.'."\n" ."\n" .'> * This parameter must be specified when **BackupPolicyMode** is set to **DataBackupPolicy**.'."\n" .'> * This parameter takes effect only when **BackupPolicyMode** is set to **DataBackupPolicy**.', 'type' => 'string', 'required' => false, 'example' => '7', ], ], [ 'name' => 'BackupLog', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable the log backup feature. Valid values:'."\n" ."\n" .'* **Enable**: enables the feature.'."\n" .'* **Disabled**: disables the feature.'."\n" ."\n" .'> * This parameter must be specified when **BackupPolicyMode** is set to **DataBackupPolicy**.'."\n" .'> * This parameter takes effect only when **BackupPolicyMode** is set to **DataBackupPolicy**.', 'type' => 'string', 'required' => false, 'example' => 'Enable', ], ], [ 'name' => 'LogBackupRetentionPeriod', 'in' => 'query', 'schema' => [ 'description' => 'The number of days for which the log backup is retained. Valid values: **7 to 730**. The log backup retention period cannot be longer than the data backup retention period.'."\n" ."\n" .'> * If you enable the log backup feature, you can specify the log backup retention period. This parameter is supported for instances that run MySQL and PostgreSQL.'."\n" .'> * This parameter takes effect only when **BackupPolicyMode** is set to **DataBackupPolicy** or **LogBackupPolicy**.', 'type' => 'string', 'required' => false, 'example' => '7', ], ], [ 'name' => 'EnableBackupLog', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable the log backup feature. Valid values:'."\n" ."\n" .'* **True** or **1**: enables the log backup feature.'."\n" .'* **False** or **0**: disables the log backup feature.'."\n" ."\n" .'> '."\n" ."\n" .'* You must specify this parameter when you set the **BackupPolicyMode** parameter to **LogBackupPolicy**.'."\n" ."\n" .'* This parameter takes effect only when you set the **BackupPolicyMode** parameter to **LogBackupPolicy**.'."\n", 'type' => 'string', 'required' => false, 'enumValueTitles' => [], 'example' => '1', 'enum' => [ '1', '0', 'True', 'False', ], ], ], [ 'name' => 'LocalLogRetentionHours', 'in' => 'query', 'schema' => [ 'description' => 'The number of hours for which you want to retain log backup files on the instance. Valid values: **0 to 168**. The value 0 specifies that log backup files are not retained on the instance. The value 168 is calculated based on the following formula: 7 × 24.'."\n" ."\n" .'> * This parameter must be specified when **BackupPolicyMode** is set to **LogBackupPolicy**.'."\n" .'> * This parameter takes effect only when **BackupPolicyMode** is set to **LogBackupPolicy**.', 'type' => 'string', 'required' => false, 'example' => '18', ], ], [ 'name' => 'LocalLogRetentionSpace', 'in' => 'query', 'schema' => [ 'description' => 'The maximum storage usage that is allowed for log backup files on the instance. If the storage usage for log backup files on the instance exceeds the value of this parameter, the system deletes earlier log backup files until the storage usage falls below the value of this parameter. Valid values:**0 to 50**. You can retain the default value.'."\n" ."\n" .'> * This parameter must be specified when **BackupPolicyMode** is set to **LogBackupPolicy**.'."\n" .'> * This parameter takes effect only when **BackupPolicyMode** is set to **LogBackupPolicy**.', 'type' => 'string', 'required' => false, 'example' => '30', ], ], [ 'name' => 'HighSpaceUsageProtection', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to forcefully delete log backup files from the instance when the storage usage of the instance exceeds 80% or the amount of remaining storage on the instance is less than 5 GB. Valid values: **Enable and Disable**. You can retain the default value.'."\n" ."\n" .'> * You must specify this parameter when you set the **BackupPolicyMode** parameter to **LogBackupPolicy**.'."\n" .'> * This parameter takes effect only when you set the **BackupPolicyMode** parameter to **LogBackupPolicy**.', 'type' => 'string', 'required' => false, 'example' => 'Enable', ], ], [ 'name' => 'LogBackupFrequency', 'in' => 'query', 'schema' => [ 'description' => 'The frequency at which you want to back up the logs of the instance. Valid values:'."\n" ."\n" .'* **LogInterval**: A log backup is performed every 30 minutes.'."\n" .'* The default value is the same as the data backup frequency.'."\n" ."\n" .'> * The value **LogInterval** is supported only for instances that run SQL Server.'."\n" .'> * This parameter takes effect only when **BackupPolicyMode** is set to **DataBackupPolicy**.', 'type' => 'string', 'required' => false, 'example' => 'LogInterval', ], ], [ 'name' => 'CompressType', 'in' => 'query', 'schema' => [ 'description' => 'The format that is used to compress backup data. Valid values:'."\n" ."\n" .'* **0**: Backups are not compressed.'."\n" .'* **1**: The zlib tool is used to compress backups into .tar.gz files.'."\n" .'* **2**: The zlib tool is used to compress backups in parallel.'."\n" .'* **4**: The QuickLZ tool is used to compress backups into .xb.gz files. This compression format is supported for instances that run MySQL 5.6 or MySQL 5.7. Backups in this compression format can be used to restore individual databases and tables. For more information, see [Restore individual databases and tables of an ApsaraDB RDS for MySQL instance](~~103175~~).'."\n" .'* **8**: The QuickLZ tool is used to compress backups into .xb.gz files. This compression format is supported only for instances that run MySQL 8.0. Backups in this compression format cannot be used to restore individual databases and tables.'."\n" ."\n" .'> This parameter takes effect only when **BackupPolicyMode** is set to **DataBackupPolicy**.'."\n", 'type' => 'string', 'required' => false, 'example' => '4', ], ], [ 'name' => 'ArchiveBackupRetentionPeriod', 'in' => 'query', 'schema' => [ 'description' => 'The number of days for which the archived backup is retained. The default value **0** specifies that the backup archiving feature is disabled. Valid values: **30** to **1095**.'."\n" ."\n" .'> This parameter takes effect only when **BackupPolicyMode** is set to **DataBackupPolicy**.'."\n", 'type' => 'string', 'required' => false, 'example' => '365', ], ], [ 'name' => 'ArchiveBackupKeepPolicy', 'in' => 'query', 'schema' => [ 'description' => 'The retention period of archived backup files. The number of archived backup files that can be retained within the specified retention period is specified by **ArchiveBackupKeepCount**. Default value: **0**. Valid values:'."\n" ."\n" .'* **ByMonth**'."\n" .'* **ByWeek**'."\n" .'* **KeepAll**'."\n" ."\n" .'> This parameter takes effect only when **BackupPolicyMode** is set to **DataBackupPolicy**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ByMonth', ], ], [ 'name' => 'ArchiveBackupKeepCount', 'in' => 'query', 'schema' => [ 'description' => 'The number of archived backup files that are retained. Default value: **1**. Valid values:'."\n" ."\n" .'* Valid values when **ArchiveBackupKeepPolicy** is set to **ByMonth**: **1** to **31**.'."\n" .'* Valid values when **ArchiveBackupKeepPolicy** is set to **ByWeek**: **1** to **7**.'."\n" ."\n" .'> * You do not need to specify this parameter when **ArchiveBackupKeepPolicy** is set to **KeepAll**.'."\n" .'> * This parameter takes effect only when **BackupPolicyMode** is set to **DataBackupPolicy**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'ReleasedKeepPolicy', 'in' => 'query', 'schema' => [ 'description' => 'The policy that is used to retain archived backup files if the instance is released. Valid values:'."\n" ."\n" .'* **None**: No archived backup files are retained.'."\n" .'* **Lastest**: Only the last archived backup file is retained.'."\n" .'* **All**: All archived backup files are retained.'."\n" ."\n" .'> * This parameter takes effect only when you set the **BackupPolicyMode** parameter to **DataBackupPolicy**.'."\n" .'> * If the instance uses cloud disks and was created on or after February 1, 2024, this parameter is automatically set to **Lastest**. If the instance uses local disks in the same scenario, this parameter is automatically set to **None**. For more information, see [Backup for deleted instances](~~2836955~~).', 'type' => 'string', 'required' => false, 'example' => 'None', ], ], [ 'name' => 'LogBackupLocalRetentionNumber', 'in' => 'query', 'schema' => [ 'description' => 'The number of binary log files that you want to retain on the instance. Default value: **60**. Valid values: **6** to **100**.'."\n" ."\n" .'> '."\n" ."\n" .'* This parameter takes effect only when you set the **BackupPolicyMode** parameter to **LogBackupPolicy**.'."\n" ."\n" .'* If the instance runs MySQL, you can set this parameter to \\*\\*-1\\*\\*. The value \\*\\*-1\\*\\* specifies that an unlimited number of binary log files can be retained on the instance.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '60', 'default' => '', ], ], [ 'name' => 'Category', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable the single-digit second backup feature. Valid values:'."\n" ."\n" .'* **Flash**: enables the feature.'."\n" .'* **Standard**: disables the feature.'."\n" ."\n" .'> This parameter takes effect only when **BackupPolicyMode** is set to **DataBackupPolicy**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Standard', ], ], [ 'name' => 'BackupInterval', 'in' => 'query', 'schema' => [ 'description' => 'The frequency at which you want to perform a snapshot backup on the instance. Valid values:'."\n" ."\n" .'* **-1**: No backup frequencies are specified.'."\n" .'* **30**: A snapshot backup is performed every 30 minutes.'."\n" .'* **60**: A snapshot backup is performed every 60 minutes.'."\n" .'* **120**: A snapshot backup is performed every 120 minutes.'."\n" .'* **240**: A snapshot backup is performed every 240 minutes.'."\n" .'* **480**: A snapshot backup is performed every 480 minutes.'."\n" ."\n" .'> * You can configure a backup policy by using this parameter and the **PreferredBackupPeriod** parameter. For example, if you set **PreferredBackupPeriod** to Saturday,Sunday and BackupInterval to \\*\\*-1\\*\\*, a snapshot backup is performed on every Saturday and Sunday.'."\n" .'> * If the instance runs PostgreSQL, BackupInterval is supported only when the instance is equipped with cloud disks.'."\n" .'> * If the instance runs SQL Server, BackupInterval is supported only when the snapshot backup feature is enabled for the instance. For more information, see [Enable snapshot backups for an ApsaraDB RDS for SQL Server instance](~~211143~~).'."\n" .'> * If **Category** is set to **Flash**, BackupInterval is invalid.'."\n" .'> * This parameter takes effect only when **BackupPolicyMode** is set to **DataBackupPolicy**.', 'type' => 'string', 'required' => false, 'example' => '30', ], ], [ 'name' => 'BackupMethod', 'in' => 'query', 'schema' => [ 'description' => 'The backup method of the instance. Valid values:'."\n" ."\n" .'* **Physical**: physical backup'."\n" .'* **Snapshot**: snapshot backup'."\n" ."\n" .'Default value: **Physical**.'."\n" ."\n" .'> * This parameter takes effect only on instances that run SQL Server with cloud disks.'."\n" .'> * This parameter takes effect only when **BackupPolicyMode** is set to **DataBackupPolicy**.', 'type' => 'string', 'required' => false, 'example' => 'Physical', ], ], [ 'name' => 'EnableIncrementDataBackup', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable incremental backup. Valid values:'."\n" ."\n" .'* **false** (default): disables the feature.'."\n" .'* **true**: enables the feature.'."\n" ."\n" .'> * This parameter takes effect only on instances that run SQL Server with cloud disks.'."\n" .'> * This parameter takes effect only when **BackupPolicyMode** is set to **DataBackupPolicy**.', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'BackupPriority', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether the backup settings of a secondary instance are configured. Valid values:'."\n" ."\n" .'* **1**: secondary instance preferred'."\n" .'* **2**: primary instance preferred'."\n" ."\n" .'> * This parameter is suitable only for instances that run SQL Server on RDS Cluster Edition.'."\n" .'> * This parameter takes effect only when **BackupMethod** is set to **Physical**. If **BackupMethod** is set to **Snapshot**, backups are forcefully performed on the primary instance that runs SQL Server on RDS Cluster Edition.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'CompressType' => [ 'description' => 'The method that is used to compress backups. Valid values:'."\n" ."\n" .'* **0:** Backups are not compressed.'."\n" .'* **1**: Backups are compressed by using the zlib tool.'."\n" .'* **2**: Backups are compressed in parallel by using the zlib tool.'."\n" .'* **4**: Backups are compressed by using the QuickLZ tool and can be used to restore individual databases and tables.'."\n" .'* **8**: Backups are compressed by using the QuickLZ tool but cannot be used to restore individual databases or tables. This value is supported only for instances that run MySQL 8.0.'."\n", 'type' => 'string', 'example' => '4', ], 'DBInstanceID' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5xxxxxxx', ], 'EnableBackupLog' => [ 'description' => 'Indicates whether the log backup feature is enabled. Valid values:'."\n" ."\n" .'* **1**: The feature is enabled.'."\n" .'* **0**: The feature is disabled.'."\n", 'type' => 'string', 'example' => '1', ], 'HighSpaceUsageProtection' => [ 'description' => 'Specifies whether to forcefully delete log backup files from the instance when the storage usage of the instance exceeds 80% or the amount of remaining storage on the instance is less than 5 GB.'."\n", 'type' => 'string', 'example' => 'Disable', ], 'LocalLogRetentionHours' => [ 'description' => 'The number of hours for which log backup files are retained on the instance.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '18', ], 'LocalLogRetentionSpace' => [ 'description' => 'The maximum storage usage that is allowed for log backup files on the instance.'."\n", 'type' => 'string', 'example' => '30', ], 'LogBackupLocalRetentionNumber' => [ 'description' => 'The number of binary log files on the instance.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '60', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'DA147739-AEAD-4417-9089-65E9B1D8240D', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidColdRetention.Format', 'errorMessage' => 'Invalid cold retention format.', ], [ 'errorCode' => 'InvalidLogBackupFrequency.Malformed', 'errorMessage' => 'Invalid log backup frequency.', ], [ 'errorCode' => 'InvalidBackupRetentionPeriod.Malformed', 'errorMessage' => 'The specified backup retention period is invalid.', ], [ 'errorCode' => 'BackupPropertyNotFound', 'errorMessage' => 'Backup policy not found', ], [ 'errorCode' => 'OperationDenied.SwitchToSnapshot', 'errorMessage' => 'Snapshot backup does not support cross region storage at present. Please turn off cross region backup before switching to snapshot backup mode.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'IncorrectBackupPolicy', 'errorMessage' => 'The current instance has an advanced backup policy enabled. Currently, you cannot use the OpenAPI to modify the backup policy. You need to modify the backup policy in the console.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'IncorrectCategory', 'errorMessage' => 'Current Instance type does not support Category.', ], [ 'errorCode' => 'OperationDenied.SwitchSnapshotToPhysical', 'errorMessage' => 'Only physical backup to snapshot backup is supported.', ], [ 'errorCode' => 'OperationDenied.ModifyBackupSwitchOff', 'errorMessage' => 'The switch is not turned on. It is forbidden to modify the backup mode.', ], [ 'errorCode' => 'OperationDenied.ApiForbiddenForLogBackupFrequency', 'errorMessage' => 'When the instance is a snapshot backup, the log backup frequency is not allowed to be consistent with the data backup.', ], [ 'errorCode' => 'OperationDenied.NotSupportedBackupMethod', 'errorMessage' => 'When the storage is larger than 4000 GB, only snapshot backup is supported.', ], [ 'errorCode' => 'OperationDenied.ApiForbidden', 'errorMessage' => 'Operation is not permitted.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 408 => [ [ 'errorCode' => 'NetworkOrSqlTimeoutError', 'errorMessage' => 'Failed to create login due to potential SQL Server overload or other issues that may cause the login creation fail. Please retry later.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"CompressType\\": \\"4\\",\\n \\"DBInstanceID\\": \\"rm-uf6wjk5****\\",\\n \\"EnableBackupLog\\": \\"1\\",\\n \\"HighSpaceUsageProtection\\": \\"Disable\\",\\n \\"LocalLogRetentionHours\\": 18,\\n \\"LocalLogRetentionSpace\\": \\"30\\",\\n \\"LogBackupLocalRetentionNumber\\": 60,\\n \\"RequestId\\": \\"DA147739-AEAD-4417-9089-65E9B1D8240D\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"7463B73D-35CC-4D19-A010-6B8D65D242EF\\",\\n \\"HostId\\": \\"rds.aliyuncs.com\\",\\n \\"Code\\": \\"UnsupportedOperation\\",\\n \\"Message\\": \\"The specified action is not supported.\\"\\n}"},{"type":"xml","example":"\\n Disable\\n\\trm-bp1z3xxxxx\\n\\tE4BF5598-ED12-4406-AAA4-F375428BE741\\n\\t18\\n\\t1\\n\\t30\\n 60\\n","errorExample":""}]', 'title' => 'ModifyBackupPolicy', 'description' => '### Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" .'* MariaDB'."\n" ."\n" .'### References'."\n" ."\n" .'> Before you call this operation, read the following documentation and make sure that you fully understand the prerequisites and impacts of this operation.'."\n" ."\n" .'* [Configure an automatic backup policy for an ApsaraDB RDS for MySQL instance](~~98818~~)'."\n" .'* [Configure an automatic backup policy for an ApsaraDB RDS for PostgreSQL instance](~~96772~~)'."\n" .'* [Configure an automatic backup policy for an ApsaraDB RDS for SQL Server instance](~~95717~~)'."\n" .'* [Configure an automatic backup policy for an ApsaraDB RDS for MariaDB instance](~~97147~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeBackups' => [ 'summary' => 'Queries the data backup files of an ApsaraDB RDS instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5xxxxxxx', ], ], [ 'name' => 'BackupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the backup set.'."\n", 'type' => 'string', 'required' => false, 'example' => '327329803', ], ], [ 'name' => 'BackupStatus', 'in' => 'query', 'schema' => [ 'description' => 'The status of the backup set. Valid values:'."\n" ."\n" .'* **Success**'."\n" .'* **Failed**'."\n", 'type' => 'string', 'required' => false, 'example' => 'Success', ], ], [ 'name' => 'BackupMode', 'in' => 'query', 'schema' => [ 'description' => 'The backup mode. Valid values:'."\n" ."\n" .'* **Automated**'."\n" .'* **Manual**'."\n", 'type' => 'string', 'required' => false, 'example' => 'Automated', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => false, 'example' => '2011-06-01T16:00Z', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => 'The end of the time range to query. The end time must be later than the start time. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in UTC.'."\n" ."\n" .'> We recommend that you specify a time range that is as short as possible to avoid timeout.'."\n", 'type' => 'string', 'required' => false, 'example' => '2011-06-15T16:00Z', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page. Valid values:'."\n" ."\n" .'* **30**'."\n" .'* **50**'."\n" .'* **100**'."\n" ."\n" .'Default value: **30**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '1000', 'minimum' => '30', 'example' => '30', 'default' => '30', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Valid values: any non-zero positive integer.'."\n" ."\n" .'Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', ], ], [ 'name' => 'BackupType', 'in' => 'query', 'schema' => [ 'description' => 'The backup type. Valid values:'."\n" ."\n" .'* **FullBackup**: full backup'."\n" .'* **IncrementalBackup**: incremental backup'."\n", 'type' => 'string', 'required' => false, 'example' => 'FullBackup', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Items' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Backup' => [ 'description' => 'The returned backup sets.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details of the returned backup sets.'."\n", 'type' => 'object', 'properties' => [ 'BackupDownloadLinkByDB' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'BackupDownloadLinkByDB' => [ 'description' => 'An array consisting of URLs from which you can download backup sets of individual databases.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'DataBase' => [ 'description' => 'The name of the database.'."\n", 'type' => 'string', 'example' => 'dbs', ], 'DownloadLink' => [ 'description' => 'The public URL from which you can download the backup set.'."\n", 'type' => 'string', 'example' => 'https://cn-hangzhou.bak.rds.aliyuncs.com/custins53664665/hins18676859_2021072909473127987849.zip?Expires=*****&dbList=tb1', ], 'IntranetDownloadLink' => [ 'description' => 'The internal URL from which you can download the backup set.'."\n", 'type' => 'string', 'example' => 'https://cn-hangzhou-internal.bak.rds.aliyuncs.com/custins53664665/hins18676859_2021072909473127987849.zip?Expires=*****&dbList=tb1', ], ], ], ], ], ], 'BackupDownloadURL' => [ 'description' => 'The URL that is used to download the backup set over the Internet. If the backup set cannot be downloaded, null is returned.'."\n" ."\n" .'> For example, if BackupMethod of an ApsaraDB RDS for SQL Server instance is set to **Snapshot**, a null string is returned.'."\n", 'type' => 'string', 'example' => 'http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/xxxxx', ], 'BackupEndTime' => [ 'description' => 'The end time of the backup task. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm*Z format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2019-02-13T12:20:00Z', ], 'BackupId' => [ 'description' => 'The ID of the backup set.'."\n", 'type' => 'string', 'example' => '321020562', ], 'BackupInitiator' => [ 'description' => 'The initiator of the backup task. Valid values:'."\n" ."\n" .'* **System**'."\n" .'* **User**'."\n", 'type' => 'string', 'example' => 'System', ], 'BackupIntranetDownloadURL' => [ 'description' => 'The URL that is used to download the backup set over an internal network. If the backup set cannot be downloaded, null is returned.'."\n" ."\n" .'> For example, if BackupMethod of an ApsaraDB RDS for SQL Server instance is set to **Snapshot**, a null string is returned.'."\n", 'type' => 'string', 'example' => 'http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/xxxxx', ], 'BackupMethod' => [ 'description' => 'The method that is used to generate the backup set. Valid values:'."\n" ."\n" .'* **Logical**: logical backup'."\n" .'* **Physical**: physical backup'."\n" .'* **Snapshot**: snapshot backup'."\n", 'type' => 'string', 'example' => 'Physical', ], 'BackupMode' => [ 'description' => 'The backup mode of the backup set. Valid values:'."\n" ."\n" .'* **Automated**'."\n" .'* **Manual**'."\n", 'type' => 'string', 'example' => 'Automated', ], 'BackupSize' => [ 'description' => 'The size of the data backup file. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2167808', ], 'BackupStartTime' => [ 'description' => 'The start time of the backup. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm*Z format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2019-02-03T12:20:00Z', ], 'BackupStatus' => [ 'description' => 'The state of the backup set.'."\n", 'type' => 'string', 'example' => 'Success', ], 'BackupType' => [ 'description' => 'The backup type of the backup set. Valid values:'."\n" ."\n" .'* **FullBackup**'."\n" .'* **IncrementalBackup**'."\n", 'type' => 'string', 'example' => 'FullBackup', ], 'Checksum' => [ 'description' => 'The checksum. The value of this parameter is calculated by using the CRC64 algorithm.'."\n", 'type' => 'string', 'example' => '1835830439**********', ], 'ConsistentTime' => [ 'description' => 'The point in time at which the data in the backup set is consistent. The return value of this parameter is a timestamp.'."\n" ."\n" .'> If the instance runs MySQL 5.6, a timestamp is returned. Otherwise, the value 0 is returned.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1576506856', ], 'CopyOnlyBackup' => [ 'description' => 'The backup mode of the backup set. Valid values:'."\n" ."\n" .'* 0: the standard mode. This mode supports full backups and incremental backups.'."\n" .'* 1: the copy-only mode. This mode supports only full backups.'."\n" ."\n" .'> This parameter is returned only when the instance runs SQL Server.'."\n", 'type' => 'string', 'example' => '0', ], 'DBInstanceId' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5xxxxxxx', ], 'Encryption' => [ 'description' => 'The encryption information about the backup set.'."\n", 'type' => 'string', 'example' => '{}', ], 'Engine' => [ 'description' => 'The type of the database engine. Valid values:'."\n" ."\n" .'* MySQL'."\n" .'* SQLServer'."\n" .'* PostgreSQL'."\n" .'* MariaDB'."\n", 'type' => 'string', 'example' => 'MySQL', ], 'EngineVersion' => [ 'description' => 'The version of the database engine.'."\n", 'type' => 'string', 'example' => '8.0', ], 'HostInstanceID' => [ 'description' => 'The ID of the instance that generates the backup set. This parameter is used to indicate whether the instance that generates the backup set is a primary instance or a secondary instance.'."\n", 'type' => 'string', 'example' => '5882781', ], 'IsAvail' => [ 'description' => 'Indicates whether the backup set is available. Valid values:'."\n" ."\n" .'* **0**: The backup set is unavailable.'."\n" .'* **1**: The backup set is available.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'MetaStatus' => [ 'description' => 'The status of the backup set that is used to restore individual databases or tables. Valid values:'."\n" ."\n" .'* **OK**: The data backup file is normal.'."\n" .'* **LARGE**: The data backup file contains an abnormally large number of tables. It cannot be used to restore individual databases or tables.'."\n" .'* **EMPTY**: The data backup file is generated from a failed backup task.'."\n" ."\n" .'> If an empty string is returned, the data backup file cannot be used to restore individual databases or tables.'."\n", 'type' => 'string', 'example' => 'OK', ], 'StorageClass' => [ 'description' => 'The storage class of the backup set. Valid values:'."\n" ."\n" .'* **0**: regular storage'."\n" .'* **1**: archive storage'."\n", 'type' => 'string', 'example' => '0', ], 'StoreStatus' => [ 'description' => 'Indicates whether the backup set can be deleted. Valid values:'."\n" ."\n" .'* **Enabled**: The backup set can be deleted.'."\n" .'* **Disabled**: The backup set cannot be deleted.'."\n", 'type' => 'string', 'example' => 'Disabled', ], 'ExpectExpireTime' => [ 'type' => 'string', ], ], ], ], ], ], 'PageNumber' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'string', 'example' => '1', ], 'PageRecordCount' => [ 'description' => 'The number of backup sets on the current page.'."\n", 'type' => 'string', 'example' => '30', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1A6D328C-84B8-40DC-BF49-6C73984D7494', ], 'TotalEcsSnapshotSize' => [ 'description' => 'The size of the snapshot chain of the instance. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'TotalRecordCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'string', 'example' => '100', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidRestoreTime.Malformed', 'errorMessage' => 'The requested restoreTime param is invalid, or the requested restoreTime is not within the scope of the instance backup.', ], [ 'errorCode' => 'InvalidPageNumbers.Malformed', 'errorMessage' => 'Specified page number is not valid.', ], [ 'errorCode' => 'InvalidStartTime.Format', 'errorMessage' => 'Specified start time is not valid.', ], [ 'errorCode' => 'InvalidEndTime.Format', 'errorMessage' => 'Specified end time is not valid.', ], [ 'errorCode' => 'InvalidParameterCombination', 'errorMessage' => 'The end time must be greater than the start time', ], [ 'errorCode' => 'InvalidDBinstanceClass.ValueNotSupported', 'errorMessage' => 'The specified parameter DBinstanceClass is invalid.', ], [ 'errorCode' => 'InvalidBackupSetLocation.Format', 'errorMessage' => 'Specified backup set location is not valid.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'InvalidMaxRecordsPerPage.Malformed', 'errorMessage' => 'Specified record number is not valid.', ], [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', ], [ 'errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance does not exist or is not supported.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Items\\": {\\n \\"Backup\\": [\\n {\\n \\"BackupDownloadLinkByDB\\": {\\n \\"BackupDownloadLinkByDB\\": [\\n {\\n \\"DataBase\\": \\"dbs\\",\\n \\"DownloadLink\\": \\"https://cn-hangzhou.bak.rds.aliyuncs.com/custins53664665/hins18676859_2021072909473127987849.zip?Expires=****&dbList=tb1\\",\\n \\"IntranetDownloadLink\\": \\"https://cn-hangzhou-internal.bak.rds.aliyuncs.com/custins53664665/hins18676859_2021072909473127987849.zip?Expires=****&dbList=tb1\\"\\n }\\n ]\\n },\\n \\"BackupDownloadURL\\": \\"http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/****\\",\\n \\"BackupEndTime\\": \\"2019-02-13T12:20:00Z\\",\\n \\"BackupId\\": \\"321020562\\",\\n \\"BackupInitiator\\": \\"System\\",\\n \\"BackupIntranetDownloadURL\\": \\"http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/****\\",\\n \\"BackupMethod\\": \\"Physical\\",\\n \\"BackupMode\\": \\"Automated\\",\\n \\"BackupSize\\": 2167808,\\n \\"BackupStartTime\\": \\"2019-02-03T12:20:00Z\\",\\n \\"BackupStatus\\": \\"Success\\",\\n \\"BackupType\\": \\"FullBackup\\",\\n \\"Checksum\\": \\"1835830439****\\",\\n \\"ConsistentTime\\": 1576506856,\\n \\"CopyOnlyBackup\\": \\"0\\",\\n \\"DBInstanceId\\": \\"rm-uf6wjk5****\\",\\n \\"Encryption\\": \\"{}\\",\\n \\"Engine\\": \\"MySQL\\",\\n \\"EngineVersion\\": \\"8.0\\",\\n \\"HostInstanceID\\": \\"5882781\\",\\n \\"IsAvail\\": 1,\\n \\"MetaStatus\\": \\"OK\\",\\n \\"StorageClass\\": \\"0\\",\\n \\"StoreStatus\\": \\"Disabled\\",\\n \\"ExpectExpireTime\\": \\"2025-06-17T12:10:23Z\\"\\n }\\n ]\\n },\\n \\"PageNumber\\": \\"1\\",\\n \\"PageRecordCount\\": \\"30\\",\\n \\"RequestId\\": \\"1A6D328C-84B8-40DC-BF49-6C73984D7494\\",\\n \\"TotalEcsSnapshotSize\\": 0,\\n \\"TotalRecordCount\\": \\"100\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 100\\n 0\\n 30\\n 1A6D328C-84B8-40DC-BF49-6C73984D7494\\n 1\\n \\n \\n Physical\\n System\\n 0\\n http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/xxxxx\\n 2167808\\n Automated\\n 321020562\\n 1\\n {}\\n 5882781\\n Disabled\\n http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/xxxxx\\n rm-uf6wjk5xxxxxxx\\n 0\\n 2019-02-13T12:20:00Z\\n 1576506856\\n 2019-02-03T12:20:00Z\\n OK\\n FullBackup\\n Success\\n \\n \\n https://cn-hangzhou.bak.rds.aliyuncs.com/custins53664665/hins18676859_2021072909473127987849.zip?Expires=*****&dbList=tb1\\n https://cn-hangzhou-internal.bak.rds.aliyuncs.com/custins53664665/hins18676859_2021072909473127987849.zip?Expires=*****&dbList=tb1\\n dbs\\n \\n \\n \\n \\n","errorExample":""}]', 'title' => 'DescribeBackups', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* RDS MySQL'."\n" .'* RDS PostgreSQL'."\n" .'* RDS SQL Server'."\n" .'* RDS MariaDB'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeDetachedBackups' => [ 'summary' => 'Queries the data backup files of an ApsaraDB RDS instance that is released.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'rm-uf6wjk5xxxxxxx', ], ], [ 'name' => 'BackupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the backup set.'."\n", 'type' => 'string', 'required' => false, 'example' => '327xxxxx3', ], ], [ 'name' => 'BackupStatus', 'in' => 'query', 'schema' => [ 'description' => 'The status of the backup set. Valid values:'."\n" ."\n" .'* **Success**'."\n" .'* **Failed**'."\n", 'type' => 'string', 'required' => false, 'example' => 'Success', ], ], [ 'name' => 'BackupMode', 'in' => 'query', 'schema' => [ 'description' => 'The backup method. Valid values:'."\n" ."\n" .'* **Automated**'."\n" .'* **Manual**'."\n", 'type' => 'string', 'required' => false, 'example' => 'Automated', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => 'The beginning of the time range to query.'."\n" ."\n" .'Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => false, 'example' => '2021-03-01T16:00Z', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => 'The end of the time range to query. The end time must be later than the start time.'."\n" ."\n" .'Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => false, 'example' => '2021-03-15T16:00Z', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page. Valid values:'."\n" ."\n" .'* **30**'."\n" .'* **50**'."\n" .'* **100**'."\n" ."\n" .'> The default value is **30**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '30', 'example' => '30', 'default' => '30', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => 'The page number. Pages start from page 1.'."\n" ."\n" .'> The default value is 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', ], ], [ 'name' => 'Region', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy*****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Items' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Backup' => [ 'description' => 'The queried backup sets.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'BackupDownloadURL' => [ 'description' => 'The URL that is used to download the diagnostic report over the Internet. If the diagnostic report cannot be downloaded, an empty string is returned.'."\n", 'type' => 'string', 'example' => 'http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/xxxxx', ], 'BackupEndTime' => [ 'description' => 'The end time of the backup task.'."\n" ."\n" .'The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm*Z format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2019-02-13T12:20:00Z', ], 'BackupId' => [ 'description' => 'The ID of the backup set.'."\n", 'type' => 'string', 'example' => '321020562', ], 'BackupIntranetDownloadURL' => [ 'description' => 'The URL that is used to download the log file over an internal network. If the log file cannot be downloaded, an empty string is returned.'."\n", 'type' => 'string', 'example' => 'http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/xxxxx', ], 'BackupMethod' => [ 'description' => 'The method that is used to generate the data backup file. Valid values:'."\n" ."\n" .'* **Logical**: logical backup'."\n" .'* **Physical**: physical backup'."\n", 'type' => 'string', 'example' => 'Physical', ], 'BackupMode' => [ 'description' => 'The backup method. Valid values:'."\n" ."\n" .'* **Automated**'."\n" .'* **Manual**'."\n", 'type' => 'string', 'example' => 'Automated', ], 'BackupSize' => [ 'description' => 'The backup size. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2167808', ], 'BackupStartTime' => [ 'description' => 'The start time of the backup task.'."\n" ."\n" .'The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm*Z format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2019-02-03T12:20:00Z', ], 'BackupStatus' => [ 'description' => 'The status of the backup set. Valid values:'."\n" ."\n" .'* **Success**'."\n" .'* **Failed**'."\n", 'type' => 'string', 'example' => 'Success', ], 'BackupType' => [ 'description' => 'The backup type of the backup file. Valid values:'."\n" ."\n" .'* **FullBackup**'."\n" .'* **IncrementalBackup**'."\n", 'type' => 'string', 'example' => 'FullBackup', ], 'ConsistentTime' => [ 'description' => 'The point in time at which the data in the backup set is consistent. The return value of this parameter is a timestamp.'."\n" ."\n" .'> If the instance runs MySQL 5.6, a timestamp is returned. Otherwise, the value 0 is returned.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1576506856', ], 'DBInstanceComment' => [ 'description' => 'The description of the instance.'."\n", 'type' => 'string', 'example' => 'test', ], 'DBInstanceId' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5xxxxxxx', ], 'HostInstanceID' => [ 'description' => 'The ID of the instance that generates the backup set. This parameter is used to indicate whether the instance that generates the backup set is a primary instance or a secondary instance.'."\n", 'type' => 'string', 'example' => '5882781', ], 'IsAvail' => [ 'description' => 'Indicates whether the backup set is available. Valid values:'."\n" ."\n" .'* **0**: The backup set is unavailable.'."\n" .'* **1**: The backup set is available.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'MetaStatus' => [ 'description' => 'The status of the backup set that is used to restore individual databases or tables. Valid values:'."\n" ."\n" .'* **OK**: The backup set is normal.'."\n" .'* **LARGE**: The backup set contains an abnormally large number of tables. It cannot be used to restore individual databases or tables.'."\n" .'* **EMPTY**: The backup set is generated from a failed backup task.'."\n", 'type' => 'string', 'example' => 'OK', ], 'StoreStatus' => [ 'description' => 'Indicates whether the data backup file can be deleted. Valid values:'."\n" ."\n" .'* **Enabled**'."\n" .'* **Disabled**'."\n", 'type' => 'string', 'example' => 'Disabled', ], ], ], ], ], ], 'PageNumber' => [ 'description' => 'The page number.'."\n", 'type' => 'string', 'example' => '1', ], 'PageRecordCount' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'string', 'example' => '30', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1A6D328C-84B8-40DC-BF49-6C73984D7494', ], 'TotalRecordCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'string', 'example' => '100', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Items\\": {\\n \\"Backup\\": [\\n {\\n \\"BackupDownloadURL\\": \\"http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/****\\",\\n \\"BackupEndTime\\": \\"2019-02-13T12:20:00Z\\",\\n \\"BackupId\\": \\"32102****\\",\\n \\"BackupIntranetDownloadURL\\": \\"http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/****\\",\\n \\"BackupMethod\\": \\"Physical\\",\\n \\"BackupMode\\": \\"Automated\\",\\n \\"BackupSize\\": 2167808,\\n \\"BackupStartTime\\": \\"2019-02-03T12:20:00Z\\",\\n \\"BackupStatus\\": \\"Success\\",\\n \\"BackupType\\": \\"FullBackup\\",\\n \\"ConsistentTime\\": 1576506856,\\n \\"DBInstanceComment\\": \\"test\\",\\n \\"DBInstanceId\\": \\"rm-uf6wjk5****\\",\\n \\"HostInstanceID\\": \\"588****\\",\\n \\"IsAvail\\": 1,\\n \\"MetaStatus\\": \\"OK\\",\\n \\"StoreStatus\\": \\"Disabled\\"\\n }\\n ]\\n },\\n \\"PageNumber\\": \\"1\\",\\n \\"PageRecordCount\\": \\"30\\",\\n \\"RequestId\\": \\"1A6D328C-84B8-40DC-BF49-6C73984D7494\\",\\n \\"TotalRecordCount\\": \\"100\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 1\\r\\n 1\\r\\n B0BBC25A-6B3E-4BFD-A052-48664294E20D\\r\\n 1\\r\\n \\r\\n \\r\\n Snapshot\\r\\n System\\r\\n 0\\r\\n Automated\\r\\n 161061273600\\r\\n 677987116\\r\\n 1\\r\\n 9232003\\r\\n \\r\\n Disabled\\r\\n rm-uf6wjk5xxxxxxx\\r\\n \\r\\n 2020-07-11T05:07:33Z\\r\\n 2020-07-11T05:07:33Z\\r\\n 0\\r\\n FullBackup\\r\\n \\r\\n DBInstance\\r\\n Success\\r\\n OSS\\r\\n \\r\\n \\r\\n 161061273600\\r\\n","errorExample":""}]', 'title' => 'DescribeDetachedBackups', 'description' => '### Supported database engine'."\n" ."\n" .'MySQL'."\n" ."\n" .'> This operation is available only for instances that use local disks.'."\n" ."\n" .'### References'."\n" ."\n" .'> Before you call this operation, read the following documentation and make sure that you fully understand the prerequisites and impacts of this operation.'."\n" ."\n" .'For more information about how to retain the data backup files of an instance after the instance is released, see [Configure automatic backup](~~98818~~).'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeBackupPolicy' => [ 'summary' => 'Queries the backup settings of an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5xxxxxxx', ], ], [ 'name' => 'BackupPolicyMode', 'in' => 'query', 'schema' => [ 'description' => 'The backup type. Valid values:'."\n" ."\n" .'* **DataBackupPolicy**: data backup'."\n" .'* **LogBackupPolicy**: log backup'."\n", 'type' => 'string', 'required' => false, 'example' => 'DataBackupPolicy', ], ], [ 'name' => 'CompressType', 'in' => 'query', 'schema' => [ 'description' => 'The method that is used to compress backup data. Valid values:'."\n" ."\n" .'* **0**: Backup data is not compressed.'."\n" .'* **1**: Backup data is compressed by using zlib.'."\n" .'* **2**: Backup data is compressed by using zlib that invokes more than one thread in parallel for each backup.'."\n" .'* **4**: Backup data is compressed by using QuickLZ and can be used to restore individual databases or tables.'."\n" .'* **8**: Backup data is compressed by using QuickLZ but cannot be used to restore individual databases or tables.'."\n", 'type' => 'string', 'required' => false, 'example' => '1', ], ], [ 'name' => 'ReleasedKeepPolicy', 'in' => 'query', 'schema' => [ 'description' => 'The policy that is used to retain archived backup files if the instance is released. Valid values:'."\n" ."\n" .'* **None**: No archived backup files are retained.'."\n" .'* **Lastest**: Only the last archived backup file is retained.'."\n" .'* **All**: All archived backup files are retained.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Lastest', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'ArchiveBackupKeepCount' => [ 'description' => 'The number of archived backup files that are retained.'."\n", 'type' => 'string', 'example' => '1', ], 'ArchiveBackupKeepPolicy' => [ 'description' => 'The cycle based on which archived backup files are retained.'."\n", 'type' => 'string', 'example' => 'ByMonth', ], 'ArchiveBackupRetentionPeriod' => [ 'description' => 'The number of days for which archived backup files are retained.'."\n", 'type' => 'string', 'example' => '365', ], 'BackupInterval' => [ 'description' => 'The backup interval. Unit: minutes.'."\n" ."\n" .'* If the instance runs MySQL, the interval is the same as the value of the Snapshot Backup Start Time parameter rather than the Snapshot Backup Period parameter in the ApsaraDB RDS console. For more information, see [Back up an ApsaraDB RDS for MySQL instance](~~98818~~).'."\n" .'* If the instance runs SQL Server, the interval is the same as the log backup frequency.'."\n", 'type' => 'string', 'example' => '30', ], 'BackupLog' => [ 'description' => 'Indicates whether the log backup feature is enabled. Valid values:'."\n" ."\n" .'* **Enable**'."\n" .'* **Disabled**'."\n", 'type' => 'string', 'example' => 'Enable', ], 'BackupMethod' => [ 'description' => 'The backup method of the instance. Valid values:'."\n" ."\n" .'* **Physical**: physical backup'."\n" .'* **Snapshot**: snapshot backup'."\n" ."\n" .'> This parameter is returned only when the instance runs SQL Server and uses cloud disks.'."\n", 'type' => 'string', 'example' => 'Physical', ], 'BackupPriority' => [ 'description' => 'The backup settings of the secondary instance. Valid values:'."\n" ."\n" .'* **1**: Secondary instance preferred'."\n" .'* **2**: Primary instance preferred'."\n" ."\n" .'> This parameter is available only for instances that run SQL Server on RDS Cluster Edition. This parameter is returned only when SupportModifyBackupPriority is set to True.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'BackupRetentionPeriod' => [ 'description' => 'The number of days for which data backup files are retained.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '7', ], 'Category' => [ 'description' => 'Indicates whether to enable the single-digit second backup feature. This feature allows ApsaraDB RDS to complete a backup within single-digit seconds. Valid values:'."\n" ."\n" .'* **Flash**: The single-digit second backup feature is enabled.'."\n" .'* **Standard**: The single-digit second backup feature is disabled.'."\n" ."\n" .'> This parameter takes effect only when you set the **BackupPolicyMode** parameter to **DataBackupPolicy**.'."\n", 'type' => 'string', 'example' => 'Standard', ], 'CompressType' => [ 'description' => 'The method that is used to compress backup data. Valid values:'."\n" ."\n" .'* **0**: Backup data is not compressed.'."\n" .'* **1**: Backup data is compressed by using zlib.'."\n" .'* **2**: Backup data is compressed by using zlib that invokes more than one thread in parallel for each backup.'."\n" .'* **4**: Backup data is compressed by using QuickLZ and can be used to restore individual databases or tables.'."\n" .'* **8**: Backup data is compressed by using QuickLZ but cannot be used to restore individual databases or tables.'."\n", 'type' => 'string', 'example' => '1', ], 'EnableBackupLog' => [ 'description' => 'Indicates whether the log backup feature is enabled. Valid values:'."\n" ."\n" .'* **1**: enabled'."\n" .'* **0**: disabled'."\n", 'type' => 'string', 'example' => '1', ], 'EnableIncrementDataBackup' => [ 'description' => 'Indicates whether incremental backup is enabled. Valid values:'."\n" ."\n" .'* **True**: Incremental backup is enabled.'."\n" .'* **False**: Incremental backup is disabled.'."\n", 'type' => 'boolean', 'example' => 'True', ], 'EnablePitrProtection' => [ 'description' => 'Indicates whether the point-in-time restoration (PITR) feature is enabled. The PITR feature is an enhancement of the log backup feature. Valid values:'."\n" ."\n" .'* **True**'."\n" .'* **False**'."\n" ."\n" .'> This parameter is returned only when the instance runs MySQL. For more information, see [Configure the PITR feature](~~2666046~~).'."\n", 'type' => 'boolean', 'example' => 'True', ], 'HighSpaceUsageProtection' => [ 'description' => 'Indicates whether the log backup deletion feature is enabled. If the disk usage exceeds 80% or the remaining disk space is less than 5 GB on the instance, this feature deletes binary log files. Valid values:'."\n" ."\n" .'* **Disable**'."\n" .'* **Enable**'."\n", 'type' => 'string', 'example' => 'Enable', ], 'LocalLogRetentionHours' => [ 'description' => 'The number of hours for which log backup files are retained on the instance.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'LocalLogRetentionSpace' => [ 'description' => 'The maximum storage usage that is allowed for log files on the instance.'."\n", 'type' => 'string', 'example' => '30', ], 'LogBackupFrequency' => [ 'description' => 'The backup frequency of logs. Valid values:'."\n" ."\n" .'* **LogInterval**: Log backups are performed every 30 minutes.'."\n" .'* Default value: same as the value of the **PreferredBackupPeriod** parameter.'."\n" ."\n" .'> This parameter is returned only when the instance runs SQL Server.'."\n", 'type' => 'string', 'example' => 'LogInterval', ], 'LogBackupLocalRetentionNumber' => [ 'description' => 'The number of binary log files that you want to retain on the instance.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '60', ], 'LogBackupRetentionPeriod' => [ 'description' => 'The number of days for which log backup files are retained.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '7', ], 'PitrRetentionPeriod' => [ 'description' => 'The number of days during which you can restore data of the instance to any point in time.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '7', ], 'PreferredBackupPeriod' => [ 'description' => 'The cycle based on which you want to perform a backup. Separate multiple values with commas (,). Valid values:'."\n" ."\n" .'* **Monday**'."\n" .'* **Tuesday**'."\n" .'* **Wednesday**'."\n" .'* **Thursday**'."\n" .'* **Friday**'."\n" .'* **Saturday**'."\n" .'* **Sunday**'."\n", 'type' => 'string', 'example' => 'Monday,Wednesday,Friday,Sunday', ], 'PreferredBackupTime' => [ 'description' => 'The time when a data backup is performed. The time follows the ISO 8601 standard in the *HH:mm*Z-*HH:mm*Z format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '15:00Z-16:00Z', ], 'PreferredNextBackupTime' => [ 'description' => 'The time when the next backup is performed. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm*Z format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2018-01-19T15:15Z', ], 'ReleasedKeepPolicy' => [ 'description' => 'The policy that is used to retain archived backup files if the instance is released. Valid values:'."\n" ."\n" .'* **None**: No archived backup files are retained.'."\n" .'* **Lastest**: Only the last archived backup file is retained.'."\n" .'* **All**: All archived backup files are retained.'."\n", 'type' => 'string', 'example' => 'None', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'B87E2AB3-B7C9-4394-9160-7F639F732031', ], 'SupportModifyBackupPriority' => [ 'description' => 'Indicates whether the backup settings of a secondary instance can be modified. Valid values:'."\n" ."\n" .'* **True**'."\n" .'* **False**'."\n", 'type' => 'boolean', 'example' => 'False', ], 'SupportReleasedKeep' => [ 'description' => 'A reserved parameter.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'SupportVolumeShadowCopy' => [ 'description' => 'Indicates whether the instance supports snapshot backups. Valid values:'."\n" ."\n" .'* **1**: The instance supports snapshot backups.'."\n" .'* **0**: The instance does not support snapshot backups.'."\n" ."\n" .'> This parameter is returned only when the instance runs SQL Server.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'SupportsHighFrequencyBackup' => [ 'description' => 'Indicates whether log backups for SQL Server are performed verery five minutes.'."\n" ."\n" .'* 0: No'."\n" .'* 1: Yes'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'IO.Exception', 'errorMessage' => 'IO exception, retry later.', ], [ 'errorCode' => 'InternalFailure', 'errorMessage' => 'Internal failure, retry later.', ], [ 'errorCode' => 'InvalidParameter.OwnerAccount', 'errorMessage' => 'The specified parameter OwnerAccount is not valid.', ], [ 'errorCode' => 'InvalidEngine.Malformed', 'errorMessage' => 'Specified engine is not valid.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'Specified instance does not exist or not support.', ], [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'Invalid DBInstanceId NotFound.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"ArchiveBackupKeepCount\\": \\"1\\",\\n \\"ArchiveBackupKeepPolicy\\": \\"ByMonth\\",\\n \\"ArchiveBackupRetentionPeriod\\": \\"365\\",\\n \\"BackupInterval\\": \\"30\\",\\n \\"BackupLog\\": \\"Enable\\",\\n \\"BackupMethod\\": \\"Physical\\",\\n \\"BackupPriority\\": 2,\\n \\"BackupRetentionPeriod\\": 7,\\n \\"Category\\": \\"Standard\\",\\n \\"CompressType\\": \\"1\\",\\n \\"EnableBackupLog\\": \\"1\\",\\n \\"EnableIncrementDataBackup\\": true,\\n \\"EnablePitrProtection\\": true,\\n \\"HighSpaceUsageProtection\\": \\"Enable\\",\\n \\"LocalLogRetentionHours\\": 0,\\n \\"LocalLogRetentionSpace\\": \\"30\\",\\n \\"LogBackupFrequency\\": \\"LogInterval\\",\\n \\"LogBackupLocalRetentionNumber\\": 60,\\n \\"LogBackupRetentionPeriod\\": 7,\\n \\"PitrRetentionPeriod\\": 7,\\n \\"PreferredBackupPeriod\\": \\"Monday,Wednesday,Friday,Sunday\\",\\n \\"PreferredBackupTime\\": \\"15:00Z-16:00Z\\",\\n \\"PreferredNextBackupTime\\": \\"2018-01-19T15:15Z\\",\\n \\"ReleasedKeepPolicy\\": \\"None\\",\\n \\"RequestId\\": \\"B87E2AB3-B7C9-4394-9160-7F639F732031\\",\\n \\"SupportModifyBackupPriority\\": true,\\n \\"SupportReleasedKeep\\": 0,\\n \\"SupportVolumeShadowCopy\\": 1,\\n \\"SupportsHighFrequencyBackup\\": 0\\n}","errorExample":""},{"type":"xml","example":"\\nStandard\\n0\\n292884FE-D689-47A2-9829-C05E63366201\\n\\nNone\\nByMonth\\n00:00Z-01:00Z\\n18\\n2021-01-07T00:40Z\\nEnable\\n1\\nLogInterval\\nTuesday,Thursday,Saturday\\n1\\n7\\n60\\nEnable\\n1\\n0\\n1\\n30\\n10\\n\\n30\\n","errorExample":""}]', 'title' => 'DescribeBackupPolicy', 'description' => '### Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" .'* MariaDB'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeBackupTasks' => [ 'summary' => 'Queries the backup tasks of an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'Specifies the client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxx', ], ], [ 'name' => 'Flag', 'in' => 'query', 'schema' => [ 'description' => 'A reserved parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'None'."\n", 'default' => '1', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5xxxxxxx', ], ], [ 'name' => 'BackupJobId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the backup task.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '4762614', ], ], [ 'name' => 'BackupMode', 'in' => 'query', 'schema' => [ 'description' => 'The backup mode. Valid values:'."\n" ."\n" .'* **Automated**'."\n" .'* **Manual**'."\n", 'type' => 'string', 'required' => false, 'enumValueTitles' => [], 'example' => 'Automated', 'enum' => [ 'Automated', 'Manual', ], ], ], [ 'name' => 'BackupJobStatus', 'in' => 'query', 'schema' => [ 'description' => 'The status of the backup task. Valid values:'."\n" ."\n" .'* **NoStart**'."\n" .'* **Progressing**'."\n" ."\n" .'By default, this operation returns backup tasks in both states.'."\n", 'type' => 'string', 'required' => false, 'enumValueTitles' => [], 'example' => 'NoStart', 'enum' => [ 'NoStart', 'Progressing', ], ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Items' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'BackupJob' => [ 'description' => 'The backup tasks.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'BackupId' => [ 'description' => 'The ID of the backup set that is generated by the backup task.'."\n" ."\n" .'> If the value of the **BackupStatus** parameter is **Finished**, you can view the backup set ID only if you configure the **BackupJobId** parameter.'."\n", 'type' => 'string', 'example' => '346650271', ], 'BackupJobId' => [ 'description' => 'The ID of the backup task.'."\n", 'type' => 'string', 'example' => '4762614', ], 'BackupProgressStatus' => [ 'description' => 'The status of the backup program. Valid values:'."\n" ."\n" .'* **NoStart**'."\n" .'* **Preparing**'."\n" .'* **Waiting**'."\n" .'* **Uploading**'."\n" .'* **Checking**'."\n" .'* **Finished**'."\n", 'type' => 'string', 'example' => 'NoStart', ], 'BackupStatus' => [ 'description' => 'The status of the backup task. Valid values:'."\n" ."\n" .'* **NoStart**'."\n" .'* **Checking**'."\n" .'* **Preparing**'."\n" .'* **Waiting**'."\n" .'* **Uploading**'."\n" .'* **Finished**'."\n" .'* **Failed**'."\n" ."\n" .'> This parameter is returned only after a backup task is run.'."\n", 'type' => 'string', 'example' => 'NoStart', ], 'JobMode' => [ 'description' => 'The backup mode. Valid values:'."\n" ."\n" .'* **Automated**'."\n" .'* **Manual**'."\n", 'type' => 'string', 'example' => 'Automated', ], 'Process' => [ 'description' => 'The progress of the task in percentage.'."\n", 'type' => 'string', 'example' => '25', ], 'TaskAction' => [ 'description' => 'The type of the task. Valid values:'."\n" ."\n" .'* **TempBackupTask**: The backup task is an adhoc backup task.'."\n" .'* **NormalBackupTask**: The backup task is a common backup task.'."\n", 'type' => 'string', 'example' => 'NormalBackupTask', ], ], ], ], ], ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '90496720-2319-42A8-87CD-FCE4DF95EBED', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InternalFailure', 'errorMessage' => 'Internal failure, retry later.', ], [ 'errorCode' => 'InvalidParameter.OwnerAccount', 'errorMessage' => 'The specified parameter OwnerAccount is not valid.', ], [ 'errorCode' => 'ReadDBInstanceNotSupport', 'errorMessage' => 'The operation is not permitted due to type of the instance.', ], [ 'errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'Specified parameter is not valid', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'Invalid DBInstanceId NotFound.', ], [ 'errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'Specified instance does not exist or not support.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Items\\": {\\n \\"BackupJob\\": [\\n {\\n \\"BackupId\\": \\"34665****\\",\\n \\"BackupJobId\\": \\"476****\\",\\n \\"BackupProgressStatus\\": \\"NoStart\\",\\n \\"BackupStatus\\": \\"NoStart\\",\\n \\"JobMode\\": \\"Automated\\",\\n \\"Process\\": \\"25\\",\\n \\"TaskAction\\": \\"NormalBackupTask\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"90496720-2319-42A8-87CD-FCE4DF95EBED\\"\\n}","errorExample":""},{"type":"xml","example":"\\n\\n\\t\\n\\t\\t\\n\\t\\t\\tAutomated\\n\\t\\t\\tNoStart\\n\\t\\t\\tNormalBackupTask\\n\\t\\t\\tNoStart\\n\\t\\t\\t4762614\\n\\t\\t\\n\\t\\n\\t90496720-2319-42A8-87CD-FCE4DF95EBED\\n","errorExample":""}]', 'title' => 'DescribeBackupTasks', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* RDS MySQL'."\n" .'* RDS PostgreSQL'."\n" .'* RDS SQL Server'."\n" .'* RDS MariaDB'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeBinlogFiles' => [ 'summary' => 'Queries the binary log files of an instance that runs MySQL or MariaDB or the write-ahead logging (WAL) files of an instance that runs PostgreSQL.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5xxxxxxx', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => 'The beginning of the time range to query.'."\n" ."\n" .'Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2011-06-01T15:00:00Z', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => 'The end of the time range to query. The end time must be later than the start time.'."\n" ."\n" .'Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2011-06-20T15:00:00Z', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page.'."\n" ."\n" .'Valid values: **30** to **100**.'."\n" ."\n" .'Default value: **30**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '1000', 'minimum' => '30', 'example' => '30', 'default' => '30', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => 'The page number. Pages start from 1.'."\n" ."\n" .'Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'default' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Items' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'BinLogFile' => [ 'description' => 'The details of the log file.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Checksum' => [ 'description' => 'The checksum. The value of this parameter is calculated by using the CRC64 algorithm.'."\n", 'type' => 'string', 'example' => '18358304393468701857', ], 'DownloadLink' => [ 'description' => 'The HTTP-based download URL of the log file. If the return value of this parameter is NULL, ApsaraDB RDS does not provide a download URL for the log file.'."\n", 'type' => 'string', 'example' => 'http://rdsxxxxx.oss.aliyuncs.com/xxxxxx ', ], 'FileSize' => [ 'description' => 'The size of the log file.'."\n" ."\n" .'Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2269410', ], 'HostInstanceID' => [ 'description' => 'The ID of the instance to which the log file belongs. This parameter helps determine whether the log file is generated on the primary instance or the secondary instance.'."\n" ."\n" .'> You can log on to the ApsaraDB RDS console and go to the instance details page. In the left-side navigation pane, click **Service Availability** to view the values of **Primary Instance No.** and **Secondary Instance No.**.'."\n", 'type' => 'string', 'example' => '5841973', ], 'IntranetDownloadLink' => [ 'description' => 'The URL that is used to download files over an internal network.'."\n", 'type' => 'string', 'example' => 'http://rdslog-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/xxxxxx', ], 'LinkExpiredTime' => [ 'description' => 'The expiration time of the URL.'."\n" ."\n" .'The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2013-06-09T18:00:00Z', ], 'LogBeginTime' => [ 'description' => 'The beginning of the time range to query.'."\n" ."\n" .'The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2019-02-09T17:45:21Z', ], 'LogEndTime' => [ 'description' => 'The end of the time range to query.'."\n" ."\n" .'The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2019-02-15T13:10:28Z', ], 'LogFileName' => [ 'description' => 'The log file name.'."\n", 'type' => 'string', 'example' => '000000040000000000000019', ], 'RemoteStatus' => [ 'description' => 'The status of the log file that is stored in the Object Storage Service (OSS) bucket.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'* **Uploading**'."\n" .'* **Completed**'."\n", 'type' => 'string', 'enumValueTitles' => [ 'Completed' => '', 'Uploading' => '', ], 'example' => 'Completed', ], ], ], ], ], ], 'PageNumber' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageRecordCount' => [ 'description' => 'The number of log files on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'ED169A3E-1657-4104-82AB-24EA8CD0DB75', ], 'TotalFileSize' => [ 'description' => 'The total size of the log file.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2269410', ], 'TotalRecordCount' => [ 'description' => 'The total number of log files.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'ParameterLeastAssociate', 'errorMessage' => 'Must input at least one optional parameter.', ], [ 'errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'Specified parameter is not valid', ], [ 'errorCode' => 'ParameterAbsence', 'errorMessage' => 'Necessary parameter is absence.', ], [ 'errorCode' => 'ServiceTemporarilyClosed', 'errorMessage' => 'Service temporarily closed.', ], [ 'errorCode' => 'ReadDBInstanceNotSupport', 'errorMessage' => 'The operation is not permitted due to type of the instance.', ], [ 'errorCode' => 'InvalidStartTime.Format', 'errorMessage' => 'Specified start time is not valid.', ], [ 'errorCode' => 'InvalidEndTime.Format', 'errorMessage' => 'Specified end time is not valid.', ], [ 'errorCode' => 'InvalidParameterCombination', 'errorMessage' => 'The end time must be greater than the start time', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'IncorrectDBInstanceEngine', 'errorMessage' => 'Current DB Instance engine does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstanceCharacterType', 'errorMessage' => 'Current DB Instance character_type does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'Specified instance does not exist or not support.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Items\\": {\\n \\"BinLogFile\\": [\\n {\\n \\"Checksum\\": \\"18358304393468701857\\",\\n \\"DownloadLink\\": \\"http://****.oss.aliyuncs.com/****\\",\\n \\"FileSize\\": 2269410,\\n \\"HostInstanceID\\": \\"584****\\",\\n \\"IntranetDownloadLink\\": \\"http://****.oss-cn-hangzhou-internal.aliyuncs.com/****\\",\\n \\"LinkExpiredTime\\": \\"2013-06-09T18:00:00Z\\",\\n \\"LogBeginTime\\": \\"2019-02-09T17:45:21Z\\",\\n \\"LogEndTime\\": \\"2019-02-15T13:10:28Z\\",\\n \\"LogFileName\\": \\"000000040000000000000019\\",\\n \\"RemoteStatus\\": \\"Completed\\"\\n }\\n ]\\n },\\n \\"PageNumber\\": 1,\\n \\"PageRecordCount\\": 30,\\n \\"RequestId\\": \\"ED169A3E-1657-4104-82AB-24EA8CD0DB75\\",\\n \\"TotalFileSize\\": 2269410,\\n \\"TotalRecordCount\\": 100\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n1\\r\\n1\\r\\nC91A2FEA-DDBE-5BE1-9944-9C8DA6E45334\\r\\n1\\r\\n439562\\r\\n\\r\\n \\r\\n http://rdslog********.aliyuncs.com/mysql-bin.000071\\r\\n 2021-10-13T07:44:37Z\\r\\n 2021-10-17T03:16:50Z\\r\\n 261972378**********\\r\\n 2021-10-13T13:44:39Z\\r\\n http://rdslog********.aliyuncs.com/mysql-bin.000071\\r\\n Completed\\r\\n 1947****\\r\\n mysql-bin.000071\\r\\n 439562\\r\\n \\r\\n\\r\\n","errorExample":""}]', 'title' => 'DescribeBinlogFiles', 'description' => '### Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* MariaDB'."\n" ."\n" .'### Usage notes'."\n" ."\n" .'* If the return value of the **DownloadLink** parameter is NULL, ApsaraDB RDS does not provide a download URL.'."\n" .'* If the return value of the **DownloadLink** parameter is not NULL, ApsaraDB RDS provides a URL for you to download backup files. The expiration time of the URL is specified by the **LinkExpiredTime** parameter. You must download the backup files before the expiration time.'."\n" .'* If you use a RAM user to download backup files, you must grant permissions to the RAM user. For more information, see [Grant backup file download permissions to a RAM user with read-only permissions](~~100043~~).'."\n" .'* Each log file that is returned by this operation contains the log entries that are generated over the time range that is specified by the StartTime and EndTime parameters.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeLogBackupFiles' => [ 'summary' => 'Queries the log backup files of an ApsaraDB RDS for SQL Server instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5xxxxxxx', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2018-10-01T08:40Z', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => 'The end of the time range to query. The end time must be later than the start time. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2018-10-31T08:40Z', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Valid values: **30** to **1000**. Default value: **30**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '1000', 'minimum' => '30', 'example' => '30', 'default' => '30', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => 'The page number. Valid values: any non-zero positive integer.'."\n" ."\n" .'Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'default' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Items' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'BinLogFile' => [ 'description' => 'The details of log files.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'DownloadLink' => [ 'description' => 'The HTTP-based download URL of the log file. If the log file cannot be downloaded, an empty string is returned.'."\n", 'type' => 'string', 'example' => 'http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/xxxxx', ], 'FileSize' => [ 'description' => 'The size of the log file. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '788480', ], 'IntranetDownloadLink' => [ 'description' => 'The URL that is used to download the log file over an internal network. If the log file cannot be downloaded, an empty string is returned. This URL is valid for one hour.'."\n", 'type' => 'string', 'example' => 'http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/xxxxx', ], 'LinkExpiredTime' => [ 'description' => 'The expiration time of the URL. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2019-03-01T15:04:13Z', ], 'LogBeginTime' => [ 'description' => 'The start time of the log file. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm*Z format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2018-10-31T08:40Z', ], 'LogEndTime' => [ 'description' => 'The end time of the log file. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm*Z format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2018-10-31T08:40Z', ], ], ], ], ], ], 'PageNumber' => [ 'description' => 'The page number of the page returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageRecordCount' => [ 'description' => 'The number of log files on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'F8EC669C-FC85-43D7-AF06-C3641626B37E', ], 'TotalFileSize' => [ 'description' => 'The total size of log files. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2300', ], 'TotalRecordCount' => [ 'description' => 'The total number of log files.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '17', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'ParameterLeastAssociate', 'errorMessage' => 'Must input at least one optional parameter.', ], [ 'errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'Specified parameter is not valid.', ], [ 'errorCode' => 'ParameterAbsence', 'errorMessage' => 'Necessary parameter is absence.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'IncorrectDBInstanceEngine', 'errorMessage' => 'Current DB Instance engine does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstanceCharacterType', 'errorMessage' => 'Current DB Instance character_type does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'Specified instance does not exist or not support.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Items\\": {\\n \\"BinLogFile\\": [\\n {\\n \\"DownloadLink\\": \\"http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/****\\",\\n \\"FileSize\\": 788480,\\n \\"IntranetDownloadLink\\": \\"http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/****\\",\\n \\"LinkExpiredTime\\": \\"2019-03-01T15:04:13Z\\",\\n \\"LogBeginTime\\": \\"2018-10-31T08:40Z\\",\\n \\"LogEndTime\\": \\"2018-10-31T08:40Z\\"\\n }\\n ]\\n },\\n \\"PageNumber\\": 1,\\n \\"PageRecordCount\\": 100,\\n \\"RequestId\\": \\"F8EC669C-FC85-43D7-AF06-C3641626B37E\\",\\n \\"TotalFileSize\\": 2300,\\n \\"TotalRecordCount\\": 17\\n}","errorExample":""},{"type":"xml","example":"\\n\\n\\t\\n\\t1\\n\\t0\\n\\tF8EC669C-FC85-43D7-AF06-C3641626B37E\\n\\t0\\n\\n\\t\\n","errorExample":""}]', 'title' => 'DescribeLogBackupFiles', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'SQL Server'."\n" ."\n" .'> You can call the DescribeBinlogFiles operation to query the log files of instances that run different database engines.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeBackupDatabase' => [ 'summary' => 'Queries the databases that are involved in a backup file.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-uf6wjk5xxxxxxx', ], ], [ 'name' => 'BackupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the backup set.'."\n", 'type' => 'string', 'required' => false, 'example' => '90262212', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'DatabaseNames' => [ 'description' => 'The name of the database. Format: "db1,db2".'."\n", 'type' => 'string', 'example' => 'db1,db2', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '08A3B71B-FE08-4B03-974F-CC7EA6DB1828', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidRestoreTime.Malformed', 'errorMessage' => 'The requested restoreTime param is invalid, or the requested restoreTime is not within the scope of the instance backup.', ], [ 'errorCode' => 'InvalidPageNumbers.Malformed', 'errorMessage' => 'Specified page number is not valid.', ], [ 'errorCode' => 'InvalidStartTime.Format', 'errorMessage' => 'Specified start time is not valid.', ], [ 'errorCode' => 'InvalidEndTime.Format', 'errorMessage' => 'Specified end time is not valid.', ], [ 'errorCode' => 'InvalidParameterCombination', 'errorMessage' => 'The end time must be greater than the start time', ], [ 'errorCode' => 'InvalidDBInstanceClass.ValueNotSupported', 'errorMessage' => 'The specified parameter "DBInstanceClass" is not valid.', ], [ 'errorCode' => 'InvalidBackupSetLocation.Format', 'errorMessage' => 'Specified backup set location is not valid.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'InvalidMaxRecordsPerPage.Malformed', 'errorMessage' => 'Specified record number is not valid.', ], [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', ], [ 'errorCode' => 'ResourceConfigError', 'errorMessage' => 'The request processing has failed due to resource config error.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', ], [ 'errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance does not exist or is not supported.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"DatabaseNames\\": \\"db1,db2\\",\\n \\"RequestId\\": \\"08A3B71B-FE08-xxxx-974F-CC7EA6DBxxxx\\"\\n}","errorExample":""},{"type":"xml","example":"\\n\\n\\tdb1,db2\\n\\t08A3B71B-FE08-4B03-974F-CC7EA6DB1828\\n\\t","errorExample":""}]', 'title' => 'DescribeBackupDatabase', 'description' => '> This operation is phased out.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'CreateTempDBInstance' => [ 'summary' => 'Creates a temporary instance for an RDS instance that runs SQL Server 2008 R2 and uses local disks.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5******', ], ], [ 'name' => 'BackupId', 'in' => 'query', 'schema' => [ 'description' => 'The backup set ID. You can call the DescribeBackups operation to query the backup set ID.'."\n" ."\n" .'> You must specify at least one of **BackupId** and **RestoreTime** parameters.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '603******', ], ], [ 'name' => 'RestoreTime', 'in' => 'query', 'schema' => [ 'description' => 'The specified point in time within the backup retention period. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time must be in UTC.'."\n" ."\n" .'> * The time can be set to a point in time within the last seven days and must be more than 30 minutes earlier than the current time. The default time zone is UTC.'."\n" .'> * You must specify at least one of the **BackupId** and **RestoreTime** parameters.', 'type' => 'string', 'required' => false, 'example' => '2011-06-11T16:00:00Z', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy*****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '248DE93F-8647-4B9D-8287-4A4A0FE56AD5', ], 'TempDBInstanceId' => [ 'description' => 'The temporary instance ID.'."\n", 'type' => 'string', 'example' => 'sub138****_rm-******', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'OperationDenied.DBInstanceStatus', 'errorMessage' => 'The operation is not permitted due to status of instance.', ], [ 'errorCode' => 'IncorrectInstanceNetworkType', 'errorMessage' => 'The specified parameter InstanceNetworkType is not valid.', ], [ 'errorCode' => 'InvalidAvailableArea.NotFound', 'errorMessage' => 'Specified available area does not exist in RDS.', ], [ 'errorCode' => 'InvalidRestoreType.Format', 'errorMessage' => 'Specified restore type is not valid.', ], [ 'errorCode' => 'ParamTypeError', 'errorMessage' => 'The parameter type error.', ], [ 'errorCode' => 'InvalidRetainInstance.Format', 'errorMessage' => 'Specified retain instance is not valid.', ], [ 'errorCode' => 'InvalidRestoreTime.Format', 'errorMessage' => 'Specified restore time is not valid.', ], [ 'errorCode' => 'InvalidRegion.Format', 'errorMessage' => 'Specified Region is not valid.', ], [ 'errorCode' => 'InvalidInstanceLevelExtraInfo', 'errorMessage' => 'Specified class code has error extra info.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OperationDenied.TempDBInstanceExists', 'errorMessage' => 'The operation is not permitted due to temp instance exist.', ], [ 'errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance engine and type does not support operations.', ], [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstanceCharacterType', 'errorMessage' => 'Current DB Instance character_type does not support this operation.', ], [ 'errorCode' => 'InvalidBackupLogStatus', 'errorMessage' => 'Current backup log enable status does not support this operation.', ], [ 'errorCode' => 'ChildDBInstanceExists', 'errorMessage' => 'Current DB instance had child instance.', ], [ 'errorCode' => 'IncorrectDBInstance', 'errorMessage' => 'The current DB instance does not support this operation.', ], [ 'errorCode' => 'IncorrectBackupSetMethod', 'errorMessage' => 'Current backup set method does not support operations.', ], [ 'errorCode' => 'IncorrectBackupSetState', 'errorMessage' => 'Current backup set state does not support operations.', ], [ 'errorCode' => 'IncorrectDBInstanceConnType', 'errorMessage' => 'Current DB instance conn type does not support this operation.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The specified db instance is not found.', ], [ 'errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', ], [ 'errorCode' => 'InvalidBackupSetID.NotFound', 'errorMessage' => 'Specified backup set ID does not exist.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"069EB9B1-DE12-54B9-8C20-822****\\",\\n \\"TempDBInstanceId\\": \\"sub16****_rm-bp13****\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"7463B73D-35CC-4D19-A010-6B8D65D242EF\\",\\n \\"HostId\\": \\"rds.aliyuncs.com\\",\\n \\"Code\\": \\"UnsupportedOperation\\",\\n \\"Message\\": \\"The specified action is not supported.\\"\\n}"},{"type":"xml","example":"\\n 248DE93F-8647-4B9D-8287-4A4A0FE56AD5\\nsub138xxxxx_juxxxxx\\n","errorExample":""}]', 'title' => 'CreateTempDBInstance', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'Your RDS instance runs SQL Server 2008 R2 with local disks.'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.'."\n" ."\n" .'[Restore the data of an ApsaraDB RDS for SQL Server instance by using a temporary RDS instance](~~95724~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeLocalAvailableRecoveryTime' => [ 'summary' => 'Queries the time range to which an RDS instance can be restored.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5xxxxxxx', ], ], [ 'name' => 'Region', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy*****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'DBInstanceId' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5xxxxxxx', ], 'RecoveryBeginTime' => [ 'description' => 'The start of the time range to which the instance can be restored.'."\n", 'type' => 'string', 'example' => '2020-03-16T07:59:18Z', ], 'RecoveryEndTime' => [ 'description' => 'The end of the time range to which the instance can be restored.'."\n", 'type' => 'string', 'example' => '2020-03-20T08:41:29Z', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '14E986AC-0F27-4FFB-8EED-9A8A3A2A0309', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'ParameterLeastAssociate', 'errorMessage' => 'Must input at least one optional parameter', ], [ 'errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'Specified parameter is not valid', ], [ 'errorCode' => 'ParameterAbsence', 'errorMessage' => 'Necessary parameter is absence.', ], [ 'errorCode' => 'MissingUserID', 'errorMessage' => 'The request is missing a user_id parameter.', ], [ 'errorCode' => 'MissingUID', 'errorMessage' => 'The request is missing a uid parameter.', ], [ 'errorCode' => 'LogBackupNotEnabled', 'errorMessage' => 'Specified instance does not enabled logbackup', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'IncorrectDBInstanceCharacterType', 'errorMessage' => 'Current DB Instance character_type does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstanceEngine', 'errorMessage' => 'Current DB Instance engine does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'Specified instance does not exist or not support.', ], [ 'errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'Specified user does not exist.', ], [ 'errorCode' => 'InvalidBinlog.NotFound', 'errorMessage' => 'The available binlog does not exist in recovery time.', ], [ 'errorCode' => 'InvalidBackup.NotFound', 'errorMessage' => 'The available backup does not exist in recovery time.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBInstanceId\\": \\"rm-bp1f****\\",\\n \\"RecoveryBeginTime\\": \\"2023-09-11T09:48:52Z\\",\\n \\"RecoveryEndTime\\": \\"2023-09-18T08:03:09Z\\",\\n \\"RequestId\\": \\"291534CC-922B-55D5-8657-B29****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n2020-03-20T08:41:29Z\\n2020-03-16T07:59:18Z\\n14E986AC-0F27-4FFB-8EED-9A8A3A2A0309\\nrm-uf6wjk5xxxxxxx\\n","errorExample":""}]', 'title' => 'DescribeLocalAvailableRecoveryTime', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* MariaDB'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeMetaList' => [ 'summary' => 'Queries the information about the databases and tables that can be restored from a specified backup set.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the generated token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxxxxx', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5xxxxxxx', ], ], [ 'name' => 'RestoreType', 'in' => 'query', 'schema' => [ 'description' => 'The restoration method that you want to use. Valid values:'."\n" ."\n" .'* **BackupSetID**: Data is restored from the backup set. If you use this value, you must also specify the **BackupSetID** parameter.'."\n" .'* **RestoreTime**: Data is restored to a specific point in time. If you use this value, you must also specify the **RestoreTime** parameter.'."\n" ."\n" .'Default value: **BackupSetID**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'BackupSetID', 'default' => '', 'enum' => [ 'BackupSetID', 'RestoreTime', ], ], ], [ 'name' => 'BackupSetID', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the backup set from which you want to restore data. You can call the DescribeBackups operation to query the IDs of data backup files.'."\n" ."\n" .'> This parameter is required when you set the **RestoreType** parameter to **BackupSetID**.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '14358', ], ], [ 'name' => 'RestoreTime', 'in' => 'query', 'schema' => [ 'description' => 'The point in time to which you want to restore data. The specified point in time must be earlier than the current time. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time must be in UTC. You can call the DescribeBackups operation to query the restorable time range.'."\n" ."\n" .'> This parameter must be specified when the **RestoreType** parameter is set to **RestoreTime**.'."\n", 'type' => 'string', 'required' => false, 'example' => '2019-05-30T03:29:10Z ', ], ], [ 'name' => 'GetDbName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the database to query. The system implements exact match based on the value of this parameter and returns the name of the matched database and the names of all tables contained in the database.'."\n" ."\n" .'> If you leave this parameter empty, the system returns all databases that are created on the instance.', 'type' => 'string', 'required' => false, 'example' => 'testdb1', ], ], [ 'name' => 'Pattern', 'in' => 'query', 'schema' => [ 'description' => 'The name of the database to query. The system implements fuzzy match based on the value of this parameter and returns only the name of the matched database.'."\n" ."\n" .'> For example, if you set the value to `test`, the system returns `testdb1` and `testdb2`. Then, you can specify the **GetDbName** parameter to query tables in the required database.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Default value: **1**.'."\n" ."\n" .'> This parameter only takes effect when you specify the **PageIndex** parameter.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageIndex', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Valid values: any non-zero positive integer.**** Default value: **1**.'."\n" ."\n" .'> This parameter only takes effect when you specify the **PageSize** parameter.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy*****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'DBInstanceName' => [ 'description' => 'The instance name.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5xxxxxxx', ], 'Items' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Meta' => [ 'description' => 'The information about the databases and tables whose data is included in the backup set.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Database' => [ 'description' => 'The database name.'."\n", 'type' => 'string', 'example' => 'testdb1', ], 'Size' => [ 'description' => 'The table size. Unit: KB.'."\n", 'type' => 'string', 'example' => '64', ], 'Tables' => [ 'description' => 'The table name.'."\n", 'type' => 'string', 'example' => 'test1', ], ], ], ], ], ], 'PageNumber' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageRecordCount' => [ 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '60F9A12A-16B8-4728-B099-4CA38D32C31C', ], 'TotalPageCount' => [ 'description' => 'The total number of pages returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'TotalRecordCount' => [ 'description' => 'The total number of returned entries.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'NoAvailableDisasterRestoreBakset', 'errorMessage' => 'No available disaster restore bakset', ], [ 'errorCode' => 'InvalidPageSize', 'errorMessage' => 'The page size is invalid', ], [ 'errorCode' => 'InvalidPageIndex', 'errorMessage' => 'The page index is invalid', ], [ 'errorCode' => 'InvalidRestoreTime.Format', 'errorMessage' => 'Specified restore time is not valid.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'InvalidMeta.Empty', 'errorMessage' => 'Meta information is empty.', ], [ 'errorCode' => 'InvalidMeta.TooLarge', 'errorMessage' => 'Meta information is too large.', ], [ 'errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', ], [ 'errorCode' => 'IncorrectEngineVersion', 'errorMessage' => 'Current engine version does not support operations.', ], [ 'errorCode' => 'InvalidBackupLogStatus', 'errorMessage' => 'Current backup log enable status does not support this operation.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidBackupSetID.NotFound', 'errorMessage' => 'Specified backup set ID does not exist.', ], [ 'errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'Specified parameter({}) is not valid.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBInstanceName\\": \\"rm-uf6wjk5****\\",\\n \\"Items\\": {\\n \\"Meta\\": [\\n {\\n \\"Database\\": \\"testdb1\\",\\n \\"Size\\": \\"64\\",\\n \\"Tables\\": \\"test1\\"\\n }\\n ]\\n },\\n \\"PageNumber\\": 1,\\n \\"PageRecordCount\\": 1,\\n \\"RequestId\\": \\"60F9A12A-16B8-4728-B099-4CA38D32C31C\\",\\n \\"TotalPageCount\\": 1,\\n \\"TotalRecordCount\\": 1\\n}","errorExample":""},{"type":"xml","example":"\\n 1\\n 1\\n 1\\n 60F9A12A-16B8-4728-B099-4CA38D32C31C\\n 1\\n \\n \\n 64\\n testdb1\\n test1\\n \\n \\n rm-uf6wjk5xxxxxxx\\n","errorExample":""}]', 'title' => 'DescribeMetaList', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'MySQL'."\n" .'> This operation is available for RDS instances that run MySQL 8.0, MySQL 5.7, and MySQL 5.6 on RDS High-availability Edition with local disks.'."\n" ."\n\n" .'### [](#)Description'."\n" ."\n" .'Before you call the [RestoreTable](~~131510~~) operation to restore individual databases or tables of an ApsaraDB RDS for MySQL instance, you can call this operation to query the information about the databases and tables that can be restored. For more information, see [Restore individual databases and tables of an ApsaraDB RDS for MySQL instance](~~103175~~).', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'RecoveryDBInstance' => [ 'summary' => 'Restores backup data of an ApsaraDB RDS for SQL Server instance to an existing instance or a new instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', ], 'parameters' => [ [ 'name' => 'DBInstanceClass', 'in' => 'query', 'schema' => [ 'description' => 'The instance type of the new instance. For more information, see [Instance types](~~26312~~).'."\n", 'type' => 'string', 'required' => false, 'example' => 'rds.mysql.s2.large', ], ], [ 'name' => 'DBInstanceStorage', 'in' => 'query', 'schema' => [ 'description' => 'The storage capacity of the new instance. Unit: GB. For more information, see [Instance types](~~26312~~).'."\n" ."\n" .'> You must set this parameter to a value that is greater than or equal to the storage capacity of the original instance.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5', ], ], [ 'name' => 'PayType', 'in' => 'query', 'schema' => [ 'description' => 'The billing method of the new instance. Valid values:'."\n" ."\n" .'* **Postpaid**: pay-as-you-go.'."\n" .'* **Prepaid**: subscription.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Postpaid', ], ], [ 'name' => 'InstanceNetworkType', 'in' => 'query', 'schema' => [ 'description' => 'The network type of the new instance. Valid values:'."\n" ."\n" .'* **Classic**'."\n" .'* **VPC**'."\n" ."\n" .'By default, the new instance uses the same network type as the original instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'VPC', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the original instance.'."\n" ."\n" .'> * If you specify BackupId, you do not need to specify this parameter.'."\n" .'> * If you specify RestoreTime, you must also specify this parameter.', 'type' => 'string', 'required' => false, 'example' => 'rm-xxxxxxxx1', ], ], [ 'name' => 'TargetDBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the destination instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rm-uf6wjk5xxxxxxx', ], ], [ 'name' => 'DbNames', 'in' => 'query', 'schema' => [ 'description' => 'The name of the database. When you restore data to a new instance, the format of the database name is `Original database name 1,New database name 2`.'."\n" ."\n" .'> For more information about how to restore data to an existing instance, see [CopyDatabaseBetweenInstances](~~2628854~~).'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Restore databases to a new instance: test1,test2. Restore databases to an existing instance: {"test1":"newtest1","test2":"newtest2"}'."\n", ], ], [ 'name' => 'BackupId', 'in' => 'query', 'schema' => [ 'description' => 'The backup set ID. You can call the DescribeBackups operation to query the backup set ID.'."\n" ."\n" .'If you specify this parameter, you do not need to specify **DBInstanceId**.'."\n" ."\n" .'> You must specify at least one of the **BackupId** or **RestoreTime** parameters.'."\n", 'type' => 'string', 'required' => false, 'example' => '29304****', ], ], [ 'name' => 'RestoreTime', 'in' => 'query', 'schema' => [ 'description' => 'The point in time to which you want to restore data. The point in time must fall within the specified log backup retention period. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time must be in UTC.'."\n" ."\n" .'If you specify this parameter, you must also specify **DBInstanceId**.'."\n" ."\n" .'> You must specify at least one of **BackupId** and **RestoreTime**.'."\n", 'type' => 'string', 'required' => false, 'example' => '2011-06-11T16:00:00Z', ], ], [ 'name' => 'VPCId', 'in' => 'query', 'schema' => [ 'description' => 'The VPC ID of the new instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vpc-xxxxxxxxxxx', ], ], [ 'name' => 'VSwitchId', 'in' => 'query', 'schema' => [ 'description' => 'The vSwitch ID of the new instance. If you specify more than one vSwitch ID, you must separate the IDs with commas (,).'."\n", 'type' => 'string', 'required' => false, 'example' => 'vsw-xxxxxxxxxxx', ], ], [ 'name' => 'PrivateIpAddress', 'in' => 'query', 'schema' => [ 'description' => 'The internal IP address of the new instance. The internal IP address must be within the CIDR block that is supported by the specified vSwitch. The system automatically assigns an internal IP address based on the values of the **VPCId** and **VSwitchId** parameters.'."\n", 'type' => 'string', 'required' => false, 'example' => '172.XXX.XXX.69', ], ], [ 'name' => 'UsedTime', 'in' => 'query', 'schema' => [ 'description' => 'The subscription duration of the instance. Valid values:'."\n" ."\n" .'* Valid values when **Period** is set to **Year**: **1 to 3**.****'."\n" .'* Valid values when **Period** is set to **Month**: **1 to 9**.****'."\n" ."\n" .'> This parameter must be specified when PayType is set to **Prepaid**.'."\n", 'type' => 'string', 'required' => false, 'example' => '1', ], ], [ 'name' => 'Period', 'in' => 'query', 'schema' => [ 'description' => 'The unit that is used to calculate the billing cycle of the new instance. This parameter takes effect only when you select the subscription billing method for the new instance. Valid values:'."\n" ."\n" .'* **Year**'."\n" .'* **Month**'."\n" ."\n" .'> This parameter must be specified when **PayType** is set to **Prepaid**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Month', ], ], [ 'name' => 'DBInstanceStorageType', 'in' => 'query', 'schema' => [ 'description' => 'The storage type of the new instance. Valid values:'."\n" ."\n" .'* **local_ssd/ephemeral_ssd**: local SSD'."\n" .'* **cloud_ssd**: standard SSD.'."\n" .'* **cloud_essd**: enhanced SSD (ESSD)'."\n", 'type' => 'string', 'required' => false, 'example' => 'local_ssd', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'DBInstanceId' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-xxxxxxx', ], 'OrderId' => [ 'description' => 'The order ID.'."\n", 'type' => 'string', 'example' => '54325****', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'EFB6083A-7699-489B-8278-C0CB4793A96E', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'IllegalParameter', 'errorMessage' => 'illegal parameter, param is empty.', ], [ 'errorCode' => 'InvalidRecoveryDbInstance.StorageSize', 'errorMessage' => 'The disk space of the new instance cannot be less than that of the current instance', ], [ 'errorCode' => 'DBCountLimitExceeded', 'errorMessage' => 'Db count limit exceeded.', ], [ 'errorCode' => 'UnsupportExtendDisk.NotSupport', 'errorMessage' => 'Specified DB instance is unsupport extend disk.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'Forbidden.SnapshotRecovery', 'errorMessage' => 'Snapshot backup does not support partial restore', ], [ 'errorCode' => 'StorageLimitExceeded', 'errorMessage' => 'Exceeding the allowed Storage of DB instance', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 408 => [ [ 'errorCode' => 'NetworkOrSqlTimeoutError', 'errorMessage' => 'Failed to create login due to potential SQL Server overload or other issues that may cause the login creation fail. Please retry later.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBInstanceId\\": \\"rm-bp1v****\\",\\n \\"OrderId\\": \\"2270972****\\",\\n \\"RequestId\\": \\"E4CDD460-2618-51FE-BD0B-A1****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n rm-xxxxxxx\\n EFB6083A-7699-489B-8278-C0CB4793A96E\\n 54325****\\n","errorExample":""}]', 'title' => 'RecoveryDBInstance', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'SQL Server 2012 or later'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.'."\n" ."\n" .'[Restore the data of an ApsaraDB RDS for SQL Server instance](~~95722~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'CloneDBInstance' => [ 'summary' => 'Restores the data of an original instance to a new instance. The new instance is called a cloned instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => '0c593ea1-3bea-11e9-b96b-88**********', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'ZoneId', 'in' => 'query', 'schema' => [ 'description' => 'The zone ID of the primary instance. You can call the DescribeRegions operation to query the zone ID.'."\n" ."\n" .'> Set this value to the zone ID of the original instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-b', ], ], [ 'name' => 'DBInstanceClass', 'in' => 'query', 'schema' => [ 'description' => 'The instance type of the new instance. For information, see [Primary ApsaraDB RDS instance types](~~26312~~).'."\n" ."\n" .'> By default, the new instance uses the same instance type as the original primary instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'mysql.n1.micro.1', ], ], [ 'name' => 'DBInstanceStorage', 'in' => 'query', 'schema' => [ 'description' => 'The storage capacity of the new instance. Unit: GB. You can increase the storage capacity in increments of 5 GB. For more information, see [Primary ApsaraDB RDS instance types](~~26312~~).'."\n" ."\n" .'> By default, the new instance has the same storage capacity as the original primary instance.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1000', ], ], [ 'name' => 'DBInstanceDescription', 'in' => 'query', 'schema' => [ 'description' => 'The instance name. The value must be 2 to 255 characters in length The value can contain letters, digits, underscores (\\_), and hyphens (-), and must start with a letter.'."\n" ."\n" .'> The value cannot start with http:// or https://.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testInstance', ], ], [ 'name' => 'DbNames', 'in' => 'query', 'schema' => [ 'description' => 'The name of the database. If you specify more than one database, the value is in the following format: `Original database name 1,Original database name 2`.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test1,test2', ], ], [ 'name' => 'PayType', 'in' => 'query', 'schema' => [ 'description' => 'The billing method of the instance. Valid values:'."\n" ."\n" .'* **Postpaid**: pay-as-you-go.'."\n" .'* **Prepaid**: subscription.'."\n" .'* **Serverless**: serverless. This value is not supported for instances that run MariaDB. For more information, see [Overview of serverless ApsaraDB RDS for MySQL instances](~~411291~~), [Overview of serverless ApsaraDB RDS for SQL Server instances](~~604344~~), and [Overview of serverless ApsaraDB RDS for PostgreSQL instances](~~607742~~).'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Postpaid', ], ], [ 'name' => 'InstanceNetworkType', 'in' => 'query', 'schema' => [ 'description' => 'The network type of the new instance. Valid values:'."\n" ."\n" .'* **VPC**'."\n" .'* **Classic**'."\n" ."\n" .'> By default, the new instance has the same network type as the original primary instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'VPC', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5xxxxxxxxxx', 'maxLength' => 65535, 'minLength' => 1, ], ], [ 'name' => 'BackupId', 'in' => 'query', 'schema' => [ 'description' => 'The backup set ID.'."\n" ."\n" .'You can call the DescribeBackups operation to query the backup set ID.'."\n" ."\n" .'> You must specify at least one of the **BackupId** or **RestoreTime** parameters.'."\n", 'type' => 'string', 'required' => false, 'example' => '902****', ], ], [ 'name' => 'RestoreTime', 'in' => 'query', 'schema' => [ 'description' => 'The point in time to which you want to restore data. The point in time must fall within the specified backup retention period. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time must be in UTC.'."\n" ."\n" .'> You must specify at least one of the **BackupId** and **RestoreTime** parameters.'."\n", 'type' => 'string', 'required' => false, 'example' => '2011-06-11T16:00:00Z', ], ], [ 'name' => 'VPCId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the virtual private cloud (VPC).'."\n" ."\n" .'> Make sure that the VPC belongs to the required region.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vpc-uf6f7l4fg90xxxxxxxxxx', ], ], [ 'name' => 'VSwitchId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the vSwitch. The vSwitch must belong to the zone that is specified by **ZoneId**.'."\n" ."\n" .'* If you set **InstanceNetworkType** to **VPC**, you must also specify this parameter.'."\n" .'* If you specify the **ZoneSlaveId1** parameter, you must specify the IDs of two vSwitches for this parameter and separate the IDs with a comma (,).'."\n", 'type' => 'string', 'required' => false, 'example' => 'vsw-uf6adz52c2pxxxxxxxxxx', ], ], [ 'name' => 'PrivateIpAddress', 'in' => 'query', 'schema' => [ 'description' => 'The internal IP address of the new instance, which must be within the CIDR block supported by the specified vSwitch. The system automatically assigns an internal IP address based on the values of the **VPCId** and **VSwitchId** parameters.'."\n", 'type' => 'string', 'required' => false, 'example' => '172.XX.XXX.69', ], ], [ 'name' => 'UsedTime', 'in' => 'query', 'schema' => [ 'description' => 'The subscription duration of the new instance. Valid values:'."\n" ."\n" .'* If you set the **Period** parameter to **Year**, the value of the UsedTime parameter ranges from **1 to 3**.'."\n" .'* If you set the **Period** parameter to **Month**, the value of the UsedTime parameter ranges from **1 to 9**.'."\n" ."\n" .'> If you set the PayType parameter to **Prepaid**, you must also specify this parameter.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'Period', 'in' => 'query', 'schema' => [ 'description' => 'The unit that is used to calculate the billing cycle of the new instance. This parameter takes effect only when you select the subscription billing method for the new instance. Valid values:'."\n" ."\n" .'* **Year**'."\n" .'* **Month**'."\n" ."\n" .'> If you set the PayType parameter to **Prepaid**, you must specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Year', 'enum' => [ 'Year', 'Month', ], ], ], [ 'name' => 'Category', 'in' => 'query', 'schema' => [ 'description' => 'The RDS edition of the instance. Valid values:'."\n" ."\n" .'* **Basic**: RDS Basic Edition.'."\n" .'* **HighAvailability**: RDS High-availability Edition.'."\n" .'* **AlwaysOn**: RDS Cluster Edition for ApsaraDB RDS for SQL Server.'."\n" .'* **cluster**: RDS Cluster Edition for ApsaraDB RDS for MySQL.'."\n" .'* **Finance**: RDS Enterprise Edition. This edition is available only on the China site (aliyun.com).'."\n" ."\n" .'**Serverless instances**'."\n" ."\n" .'* **serverless_basic**: RDS Basic Edition. This edition is available only for serverless instances that run MySQL and PostgreSQL.'."\n" .'* **serverless_standard**: RDS High-availability Edition for ApsaraDB RDS for MySQL'."\n" .'* **serverless_ha**: RDS High-availability Edition for ApsaraDB RDS for SQL Server'."\n" ."\n" .'> You do not need to configure this parameter. The value of this parameter is the same as that of the original instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'HighAvailability', ], ], [ 'name' => 'ZoneIdSlave1', 'in' => 'query', 'schema' => [ 'description' => 'The zone ID of the secondary instance. If you set the ZoneIdSlave1 parameter and the **ZoneId** parameter to the same value, the single-zone deployment method is used. If you set the ZoneIdSlave1 parameter and the **ZoneId** parameter to different values, the multi-zone deployment method is used.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-c', ], ], [ 'name' => 'ZoneIdSlave2', 'in' => 'query', 'schema' => [ 'description' => 'The zone ID of the logger instance. If you set the ZoneIdSlave2 parameter to the same value as the **ZoneId** parameter, the single-zone deployment method is used. If you set the ZoneIdSlave2 parameter to a different value from the **ZoneId** parameter, the multi-zone deployment method is used.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-d', ], ], [ 'name' => 'DBInstanceStorageType', 'in' => 'query', 'schema' => [ 'description' => 'The storage type of the new instance. Valid values:'."\n" ."\n" .'* **general_essd** (recommend): general Enterprise SSD (ESSD)'."\n" .'* **local_ssd**: local SSD'."\n" .'* **cloud_ssd**: standard SSD'."\n" .'* **cloud_essd**: performance level 1 (PL1) ESSD'."\n" .'* **cloud_essd2**: PL2 ESSD'."\n" .'* **cloud_essd3**: PL3 ESSD'."\n" ."\n" .'> Serverless instances support only PL1 ESSDs and general ESSDs.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cloud_essd', ], ], [ 'name' => 'RestoreTable', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to restore only the databases and tables that you specify. The value **1** specifies to restore only the specified databases and tables. If you do not want to restore only the specified databases or tables, you do not need to specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => '1', ], ], [ 'name' => 'TableMeta', 'in' => 'query', 'schema' => [ 'description' => 'The information about the database and table that you want to restore. The value is in the following format: `[{"type":"db","name":"Name of Database 1","newname":"New name of Database 1","tables":[{"type":"table","name":"Name of Table 1 in Database 1","newname":"New name of Table 1"},{"type":"table","name":"Name of Table 2 in Database 1","newname":"New name of Table 2"}]},{"type":"db","name":"Name of Database 2","newname":"New name of Database 2","tables":[{"type":"table","name":"Name of Table 1 in Database 2","newname":"New name of Table 1"},{"type":"table","name":"Name of Table 2 in Database 2","newname":"New name of Table 2"}]}]`'."\n", 'type' => 'string', 'required' => false, 'example' => '[{"type":"db","name":"testdb1","newname":"testdb1_new","tables":[{"type":"table","name":"testdb1table1","newname":"testdb1table1_new"}]}]', ], ], [ 'name' => 'DedicatedHostGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the dedicated cluster.'."\n", 'type' => 'string', 'required' => false, 'example' => 'dhg-7a9xxxxxxxx', ], ], [ 'name' => 'BackupType', 'in' => 'query', 'schema' => [ 'description' => 'The type of backup that is used to restore the data of the original instance. Valid values:'."\n" ."\n" .'* **FullBackup**'."\n" .'* **IncrementalBackup**'."\n", 'type' => 'string', 'required' => false, 'example' => 'FullBackup', ], ], [ 'name' => 'DeletionProtection', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable the release protection feature for the new instance. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false** (default)'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false', ], ], [ 'name' => 'IoAccelerationEnabled', 'in' => 'query', 'schema' => [ 'description' => 'A reserved parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'None', ], ], [ 'name' => 'BurstingEnabled', 'in' => 'query', 'schema' => [ 'description' => 'An invalid parameter. You do not need to specify this parameter.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'AutoPay', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable the automatic payment feature for the new instance. Valid values:'."\n" ."\n" .'1. **true**: enables the feature. You must make sure that your account balance is sufficient.'."\n" .'2. **false**: disables the feature. An unpaid order is generated.'."\n" ."\n" .'> Default value: true. If your account balance is insufficient, you can set the AutoPay parameter to false to generate an unpaid order. Then, you can log on to the ApsaraDB RDS console to complete the payment.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true', ], ], [ 'name' => 'CustomExtraInfo', 'in' => 'query', 'schema' => [ 'type' => 'string', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'DBInstanceId' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5xxxxxxx', ], 'OrderId' => [ 'description' => 'The ID of the order.'."\n", 'type' => 'string', 'example' => '100789370****', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidAvZone.Format', 'errorMessage' => 'Specified AvZone is not valid.', ], [ 'errorCode' => 'InvalidAvZone.NotSupport', 'errorMessage' => 'Specified availableArea multiZone does not support in RDS.', ], [ 'errorCode' => 'CannotDecreaseEssdPerfLevel', 'errorMessage' => 'cannot decrease cloud essd performance level.', ], [ 'errorCode' => 'InvalidIPAddress.Conflict', 'errorMessage' => 'IP address conflict.', ], [ 'errorCode' => 'CDDC.AvailableHostsNotEnoughInZone', 'errorMessage' => 'Not enough available hosts are in the target zone.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidRecoveryDbInstance.StorageType', 'errorMessage' => 'The disk local_ssd can not clone to cloud disk type', ], [ 'errorCode' => 'InvalidRecoveryDbInstance.StorageSize', 'errorMessage' => 'The disk space of the new instance cannot be less than that of the current instance', ], [ 'errorCode' => 'InvalidDBInstanceClass.Offline', 'errorMessage' => 'The specified instance type is no longer provided. Please specify another instance type.', ], [ 'errorCode' => 'InvalidTunnelId', 'errorMessage' => 'Specified conn tunnel is not valid.', ], [ 'errorCode' => 'ZoneId.NotMatchWithCategory', 'errorMessage' => 'The number of available zones does not match the database engine or instance edition. Please reset it.', ], [ 'errorCode' => 'UnsupportExtendDisk.NotSupport', 'errorMessage' => 'Specified DB instance is unsupport extend disk.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'StopService.Clone', 'errorMessage' => 'The service has been discontinued and cloning operations on classic network instances are no longer permitted.', ], [ 'errorCode' => 'InvalidParam.UsedTime', 'errorMessage' => 'The clone expiration date cannot exceed %s.', ], [ 'errorCode' => 'MinorVersionTag.NotFound', 'errorMessage' => 'Minor version tags cannot be parsed by the instance.', ], [ 'errorCode' => 'InvalidBakset.Invalid', 'errorMessage' => 'Specified bakset is not valid.', ], [ 'errorCode' => 'InvalidParamForXfs', 'errorMessage' => 'Xfs instance must be single tenant standard instance.', ], [ 'errorCode' => 'AtLeastThreeVSwitchAvailableIp', 'errorMessage' => 'The primary vswitch requires at least three available IP addresses.', ], [ 'errorCode' => 'AtLeastTwoVSwitchAvailableIp', 'errorMessage' => 'The primary vswitch requires at least two available IP addresses.', ], ], 403 => [ [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'IncorrectCharacterType', 'errorMessage' => 'Current DB instance character type does not support this operation.', ], [ 'errorCode' => 'CloudDiskEncryptionNotSupport', 'errorMessage' => 'The encryption key is not allowed for general-purpose instance.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance does not exist or is not supported.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBInstanceId\\": \\"rm-uf6wjk5****\\",\\n \\"OrderId\\": \\"100789370****\\",\\n \\"RequestId\\": \\"1E43AAE0-BEE8-43DA-860D-EAF2****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n rm-uf6wjk5xxxxxxx\\n 1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC\\n 100789370****\\n","errorExample":""}]', 'title' => 'CloneDBInstance', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" .'* MariaDB'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.'."\n" ."\n" .'* [Restore data of an ApsaraDB RDS for MySQL instance](~~96147~~)'."\n" .'* [Restore data of an ApsaraDB RDS for PostgreSQL instance](~~96776~~)'."\n" .'* [Restore data of an ApsaraDB RDS for SQL Server instance](~~95722~~)'."\n" .'* [Restore data of an ApsaraDB RDS for MariaDB instance](~~97151~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'RestoreTable' => [ 'summary' => 'Restores individual databases or tables of an instance to the original instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the generated token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxxxxx', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5xxxxxxxxxx', ], ], [ 'name' => 'BackupId', 'in' => 'query', 'schema' => [ 'description' => 'The backup set ID. You can call the DescribeBackups operation to obtain the backup set ID.'."\n" ."\n" .'> You must specify at least one of **BackupId** or **RestoreTime** parameters.'."\n", 'type' => 'string', 'required' => false, 'example' => '9026262', ], ], [ 'name' => 'RestoreTime', 'in' => 'query', 'schema' => [ 'description' => 'The point in time to which you want to restore data. The point in time must fall within the specified log backup retention period. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time must be in UTC.'."\n" ."\n" .'> * You must specify at least one of **BackupId** and **RestoreTime**.'."\n" .'> * You must enable the log backup feature. For more information, see [Back up an ApsaraDB RDS for MySQL instance](~~98818~~).', 'type' => 'string', 'required' => false, 'example' => '2011-06-11T16:00:00Z', ], ], [ 'name' => 'TableMeta', 'in' => 'query', 'schema' => [ 'description' => 'The names of the databases and tables that you want to restore for the source instance.'."\n" ."\n" .'> ApsaraDB RDS for PostgreSQL allows you to restore only specified databases, not tables.'."\n" ."\n" .'* ApsaraDB RDS for MySQL: `[{"type":"db","name":"","newname":"","tables":[{"type":"table","name":"","newname":""},{"type":"table","name":"","newname":""}]},{"type":"db","name":"","newname":"","tables":[{"type":"table","name":"","newname":""},{"type":"table","name":"","newname":""}]}]`'."\n" .'* ApsaraDB RDS for PostgreSQL: `[{"type":"db","name":"","newname":""}]`'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '[{"type":"db","name":"testdb1","newname":"testdb1_new","tables":[{"type":"table","name":"testdb1table1","newname":"testdb1table1_new"}]}]', ], ], [ 'name' => 'InstantRecovery', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable the fast restoration feature for individual databases and tables. Valid values:'."\n" ."\n" .'* **true**: enables the feature.'."\n" .'* **false**: disables the feature.'."\n" ."\n" .'> For more information, see [Restore individual databases and tables of an ApsaraDB RDS for MySQL instance](~~103175~~).'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'EA2D4F34-01A7-46EB-A339-D80882135206', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidRestoreType.Format', 'errorMessage' => 'Specified restore type is not valid.', ], [ 'errorCode' => 'InvalidRestoreTime.Format', 'errorMessage' => 'Specified restore time is not valid.', ], [ 'errorCode' => 'InvalidBakset.Invalid', 'errorMessage' => 'Specified bakset is not valid.', ], [ 'errorCode' => 'InvalidParamTableMeta', 'errorMessage' => 'Invalid parameter TableMeta is null or not json format', ], [ 'errorCode' => 'InvalidBakHistoryDO', 'errorMessage' => 'BakHistory is inbalid when check restore TableMeta', ], [ 'errorCode' => 'InvalidBakTableMetaDO', 'errorMessage' => 'BakTableMeta in BakHistory.Info is invalid', ], [ 'errorCode' => 'InvalidParamTableMeta.Content', 'errorMessage' => 'TableMeta has duplicate db.table in newname or with common.', ], [ 'errorCode' => 'InvalidParamTableMeta.Duplicate', 'errorMessage' => 'TableMeta has duplicate db or table with other newname, commons or system', ], [ 'errorCode' => 'InvalidSourceRestoreDBName.NotFound', 'errorMessage' => 'specific source restore dbname is not found in db list', ], [ 'errorCode' => 'InvalidParamTableMetaForRestore.Content', 'errorMessage' => 'new dbname or table in TableMeta cannot be same with old when restore to source instance', ], [ 'errorCode' => 'InvalidDBName.Duplicate', 'errorMessage' => 'Specified DB name already exists in the This instance.', ], [ 'errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'Specified parameters is not valid.', ], [ 'errorCode' => 'InvalidAvZone.Format', 'errorMessage' => 'Specified AvZone is not valid.', ], [ 'errorCode' => 'InvalidRegion.Format', 'errorMessage' => 'Specified Region is not valid.', ], [ 'errorCode' => 'InvalidIP.Format', 'errorMessage' => 'Specified ip is not valid.', ], [ 'errorCode' => 'InvalidVpcParameter', 'errorMessage' => 'Specified VPCId VSwitchId or IPAddress or TunnelId is not valid.', ], [ 'errorCode' => 'MissingUserID', 'errorMessage' => 'The request is missing a user_id parameter.', ], [ 'errorCode' => 'MissingUID', 'errorMessage' => 'The request is missing a uid parameter.', ], [ 'errorCode' => 'MissBackupSetAndRestoreTime.NotFound', 'errorMessage' => 'Both BackupSet and RestoreTime are null.', ], [ 'errorCode' => 'InvalidBakHistory.DbVersionMismatch', 'errorMessage' => 'db version of bakhistory is mismatch with custins', ], [ 'errorCode' => 'DiskSize.NotEnough', 'errorMessage' => 'The disk size is not enough to restore tables.', ], [ 'errorCode' => 'InvalidSourceCategory', 'errorMessage' => 'specified source category is not supported for this function.', ], [ 'errorCode' => 'RestoreTableException', 'errorMessage' => 'RestoreTable Exception, result is null.', ], [ 'errorCode' => 'InvalidParamTableMeta.TooManyTables', 'errorMessage' => 'At most 100 tables are supported. Restoring the database is recommended.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'InvalidBackupLogStatus', 'errorMessage' => 'Current backup log enable status does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', ], [ 'errorCode' => 'IncorrectBackupSetMethod', 'errorMessage' => 'Current backup set method does not support operations.', ], [ 'errorCode' => 'IncorrectBackupSetState', 'errorMessage' => 'Current backup set state does not support operations.', ], [ 'errorCode' => 'ChildDBInstanceExists', 'errorMessage' => 'Current DB instance had child instance.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidBackup.NotFound', 'errorMessage' => 'The available backup does not exist in recovery time.', ], [ 'errorCode' => 'InvalidBinlog.NotFound', 'errorMessage' => 'The available binlog does not exist in recovery time.', ], [ 'errorCode' => 'InvalidBackupSetID.NotFound', 'errorMessage' => 'Specified backup set ID does not exist.', ], [ 'errorCode' => 'InvalidDB.NotFound', 'errorMessage' => 'Specified db does not exist or DB status does not support.', ], [ 'errorCode' => 'InvalidRegion.NotFound', 'errorMessage' => 'Specified Region does not exist in RDS.', ], [ 'errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is insufficient capacity available for the requested instance.', ], [ 'errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'Specified instance does not exist or not support.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ResourceConfigError', 'errorMessage' => 'The request processing has failed due to resource config error.', ], [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EA2D4F34-01A7-46EB-A339-D80882135206\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\nEA2D4F34-01A7-46EB-A339-D80882135206\\r\\n","errorExample":""}]', 'title' => 'RestoreTable', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> Before you call this operation, read the following topics and make sure that you fully understand the prerequisites and impacts of this operation.'."\n" ."\n" .'* [Restore individual databases and tables of an ApsaraDB RDS for MySQL instance](~~103175~~)'."\n" .'* [Restore individual databases and tables of an ApsaraDB RDS for PostgreSQL instance](~~613672~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'CreateDdrInstance' => [ 'summary' => 'Restores data to a new instance across regions.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the destination instance. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'Engine', 'in' => 'query', 'schema' => [ 'description' => 'The database engine of the destination instance. Valid values:'."\n" ."\n" .'* **MySQL**'."\n" .'* **SQLServer**'."\n" .'* **PostgreSQL**'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MySQL', ], ], [ 'name' => 'EngineVersion', 'in' => 'query', 'schema' => [ 'description' => 'The major engine version of the destination instance. The value of this parameter varies based on the value of **Engine**.'."\n" ."\n" .'* Valid values when Engine is set to MySQL: **5.5, 5.6, 5.7, and 8.0**'."\n" .'* Valid values when Engine is set to SQLServer: **2008r2, 08r2\\_ent_ha, 2012, 2012\\_ent_ha, 2012\\_std_ha, 2012\\_web, 2014\\_std_ha, 2016\\_ent_ha, 2016\\_std_ha, 2016\\_web, 2017\\_std_ha, 2017\\_ent, 2019\\_std_ha, and 2019\\_ent**'."\n" .'* Valid values when Engine is set to PostgreSQL: **9.4, 10.0, 11.0, 12.0, and 13.0**'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '5.6', ], ], [ 'name' => 'DBInstanceClass', 'in' => 'query', 'schema' => [ 'description' => 'The instance type of the destination instance. For more information, see [Primary ApsaraDB RDS instance types](~~26312~~).'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'rds.mysql.s1.small', ], ], [ 'name' => 'DBInstanceStorage', 'in' => 'query', 'schema' => [ 'description' => 'The storage capacity of the destination instance. Valid values: **5 to 2000**. Unit: GB. You can increase the storage capacity at a step size of 5 GB. For more information, see [Primary instance types](~~26312~~).'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '20', ], ], [ 'name' => 'SystemDBCharset', 'in' => 'query', 'schema' => [ 'description' => 'The character set of the destination instance. Valid values:'."\n" ."\n" .'* **utf8**'."\n" .'* **gbk**'."\n" .'* **latin1**'."\n" .'* **utf8mb4**'."\n", 'type' => 'string', 'required' => false, 'example' => 'uft8', ], ], [ 'name' => 'DBInstanceNetType', 'in' => 'query', 'schema' => [ 'description' => 'The network connection type of the destination instance. Valid values:'."\n" ."\n" .'* **Internet**'."\n" .'* **Intranet**'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Intranet', ], ], [ 'name' => 'DBInstanceDescription', 'in' => 'query', 'schema' => [ 'description' => 'The instance name. The name must be 2 to 256 characters in length. The value can contain letters, digits, underscores (\\_), and hyphens (-), and must start with a letter.'."\n" ."\n" .'> The value cannot start with http:// or https://.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Test database'."\n", ], ], [ 'name' => 'SecurityIPList', 'in' => 'query', 'schema' => [ 'description' => 'The IP address whitelist of the destination instance. If you want to add more than one entry to the IP address whitelist, separate the entries with commas (,). Each entry must be unique. You can add a maximum of 1,000 entries. For more information, see [Configure an IP address whitelist for an ApsaraDB RDS for MySQL instance](~~43185~~). The entries in the IP address whitelist must be in one of the following formats:'."\n" ."\n" .'* IP address. Example: 10.23.12.24.'."\n" .'* CIDR block. Example: 10.23.12.24/24. In this example, 24 indicates that the prefix of the CIDR block is 24 bits in length. You can replace 24 with a value that ranges from 1 to 32.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '127.0.0.1', ], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxxxxx', ], ], [ 'name' => 'PayType', 'in' => 'query', 'schema' => [ 'description' => 'The billing method of the instance. Valid values:'."\n" ."\n" .'* **Postpaid**: pay-as-you-go'."\n" .'* **Prepaid**: subscription'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Prepaid', ], ], [ 'name' => 'ZoneId', 'in' => 'query', 'schema' => [ 'description' => 'The zone ID of the destination instance. If the destination instance is deployed in multiple zones, separate the IDs of the zones with colons (:).'."\n" ."\n" .'> If you specify a virtual private cloud (VPC) and a vSwitch, you must specify this parameter to identify the zone for the vSwitch.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-b', ], ], [ 'name' => 'InstanceNetworkType', 'in' => 'query', 'schema' => [ 'description' => 'The network type of the instance. Valid values:'."\n" ."\n" .'* **VPC**'."\n" .'* **Classic**'."\n" ."\n" .'Default value: Classic.'."\n" ."\n" .'> If you set this parameter to **VPC**, you must also specify **VpcId** and **VSwitchId**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Classic', ], ], [ 'name' => 'ConnectionMode', 'in' => 'query', 'schema' => [ 'description' => 'The connection mode of the destination instance. Valid values:'."\n" ."\n" .'* **Standard**: standard mode'."\n" .'* **Safe**: database proxy mode'."\n" ."\n" .'Default value: **Standard**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Standard', ], ], [ 'name' => 'VPCId', 'in' => 'query', 'schema' => [ 'description' => 'The VPC ID of the destination instance. This parameter is available only when you set the **InstanceNetworkType** parameter to **VPC**.'."\n" ."\n" .'> If you specify this parameter, you must also specify the **ZoneId** parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vpc-xxxxxxxxxxxx', ], ], [ 'name' => 'VSwitchId', 'in' => 'query', 'schema' => [ 'description' => 'The vSwitch ID of the destination instance. If you specify more than one vSwitch, separate the IDs of the vSwitches with commas (,). This parameter is available only when you set the **InstanceNetworkType** parameter to **VPC**.'."\n" ."\n" .'> If you specify this parameter, you must also specify the **ZoneId** parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vsw-xxxxxxxxxxx', ], ], [ 'name' => 'PrivateIpAddress', 'in' => 'query', 'schema' => [ 'description' => 'The private IP address of the destination instance. The private IP address must be within the CIDR block that is supported by the specified vSwitch. The system automatically assigns an internal IP address based on the values of the **VPCId** and **VSwitchId** parameters.'."\n", 'type' => 'string', 'required' => false, 'example' => '172.XXX.XXX.69', ], ], [ 'name' => 'UsedTime', 'in' => 'query', 'schema' => [ 'description' => 'The subscription duration of the instance.'."\n" ."\n" .'* If you set **Period** to **Year**, the value of UsedTime ranges from **1 to 3**.'."\n" .'* If you set **Period** to **Month**, the value of UsedTime ranges from **1 to 9**.'."\n" ."\n" .'> If you set PayType to **Prepaid**, you must specify UsedTime.'."\n", 'type' => 'string', 'required' => false, 'example' => '2', ], ], [ 'name' => 'Period', 'in' => 'query', 'schema' => [ 'description' => 'The unit that is used to measure the subscription duration of the destination instance. Valid values:'."\n" ."\n" .'* **Year**'."\n" .'* **Month**'."\n" ."\n" .'> If you set PayType to **Prepaid**, you must specify UsedTime.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Year', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmyxxxxxxxxxx ', ], ], [ 'name' => 'RestoreType', 'in' => 'query', 'schema' => [ 'description' => 'The restoration method that you want to use. Valid values:'."\n" ."\n" .'* **BackupSet**: restores data from a backup set. If you use this value, you must also specify **BackupSetId**.'."\n" .'* **BackupTime**: restores data to a point in time. If you use this value, you must also specify **RestoreTime**, **SourceRegion**, and **SourceDBInstanceName**.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'enumValueTitles' => [], 'example' => 'BackupSet', 'enum' => [ 'BackupSet', 'BackupTime', '0', '1', ], ], ], [ 'name' => 'BackupSetId', 'in' => 'query', 'schema' => [ 'description' => 'The backup set ID that you want to use for the restoration. You can call the DescribeCrossRegionBackups operation to query backup set ID.'."\n" ."\n" .'> This parameter is required when you set the **RestoreType** parameter to **BackupSet**.'."\n", 'type' => 'string', 'required' => false, 'example' => '14***', ], ], [ 'name' => 'BackupSetRegion', 'in' => 'query', 'schema' => [ 'description' => 'The region where the backup set is located.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', ], ], [ 'name' => 'RestoreTime', 'in' => 'query', 'schema' => [ 'description' => 'The point in time to which you want to restore data. The point in time that you specify must be earlier than the current time. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time must be in UTC.'."\n" ."\n" .'> If **RestoreType** is set to **BackupTime**, you must specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => '2019-05-30T03:29:10Z', ], ], [ 'name' => 'SourceRegion', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the source instance if you want to restore data to a point in time.'."\n" ."\n" .'> If you set **RestoreType** to **BackupTime**, you must specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'SourceDBInstanceName', 'in' => 'query', 'schema' => [ 'description' => 'The source instance ID, which is used if you want to restore data to a point in time.'."\n" ."\n" .'> This parameter is required when you set the **RestoreType** parameter to **BackupTime**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rm-uf6wjk5xxxxxxx', ], ], [ 'name' => 'DBInstanceStorageType', 'in' => 'query', 'schema' => [ 'description' => 'The storage type of the destination instance. Only the local SSD storage type is supported. Default value: **local_ssd**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'local_ssd', ], ], [ 'name' => 'RoleARN', 'in' => 'query', 'schema' => [ 'description' => 'The Alibaba Cloud Resource Name (ARN) that is provided by your Alibaba Cloud account for Resource Access Management (RAM) users. RAM users can use the ARN to connect to ApsaraDB RDS to Key Management Service (KMS). You can call the [CheckCloudResourceAuthorized](~~2628797~~) operation to query the ARN.'."\n" ."\n" .'> This parameter is applicable only to ApsaraDB RDS for SQL Server instances.'."\n", 'type' => 'string', 'required' => false, 'example' => 'acs:ram::1406****:role/aliyunrdsinstanceencryptiondefaultrole', ], ], [ 'name' => 'EncryptionKey', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the customer master key (CMK) for cloud disk encryption. If this parameter is specified, cloud disk encryption is enabled and you must also specify the **RoleARN** parameter. Cloud disk encryption cannot be disabled after it is enabled. You can obtain the ID of the key in the KMS console or create a key. For more information, see [Create a key](~~181610~~).'."\n" ."\n" .'**'."\n" ."\n" .'**Notes**'."\n" ."\n" .'* This parameter is applicable only to ApsaraDB RDS for SQL Server instances.'."\n" ."\n" .'* You can leave this parameter empty. If you do not specify this parameter, you only need to specify the **RoleARN** to use the service key that is managed by ApsaraDB RDS to encrypt cloud disks.'."\n", 'type' => 'string', 'required' => false, 'example' => '749c1df7-****-****-****-****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'ConnectionString' => [ 'description' => 'The endpoint that is used to connect to the destination instance.'."\n" ."\n" .'> The **DBInstanceNetType** parameter indicates whether the endpoint is internal or public.'."\n", 'type' => 'string', 'example' => 'rm-xxxxx.mysql.rds.aliyuncs.com', ], 'DBInstanceId' => [ 'description' => 'The destination instance ID.'."\n", 'type' => 'string', 'example' => 'rm-xxxxx', ], 'OrderId' => [ 'description' => 'The order ID.'."\n", 'type' => 'string', 'example' => '2038691xxxxx', ], 'Port' => [ 'description' => 'The port number that is used to connect to the destination instance.'."\n" ."\n" .'> **DBInstanceNetType** indicates whether the port is internal or public.'."\n", 'type' => 'string', 'example' => '3306', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'E52666CC-330E-418A-8E5B-A19E3FB42D13', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidZoneId.NotSupported', 'errorMessage' => 'The Specified vpc Zone not supported.', ], [ 'errorCode' => 'InvalidDBInstanceName.Format', 'errorMessage' => 'Specified DB instance name is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceName.Duplicate', 'errorMessage' => 'Specified DB instance name already exists in the Aliyun RDS.', ], [ 'errorCode' => 'InvalidRegion.Format', 'errorMessage' => 'Specified Region is not valid.', ], [ 'errorCode' => 'InvalidServiceType.Format', 'errorMessage' => 'Specified service type is not valid.', ], [ 'errorCode' => 'InvalidEngine.Malformed', 'errorMessage' => 'Specified engine is not valid.', ], [ 'errorCode' => 'InvalidEngineVersion.Malformed', 'errorMessage' => 'Specified engine version is not valid.', ], [ 'errorCode' => 'InvalidConnectionString.Format', 'errorMessage' => 'Specified connection string is not valid.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the Aliyun RDS.', ], [ 'errorCode' => 'InvalidCharacterSetName.Format', 'errorMessage' => 'Specified character set name is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceType.Format', 'errorMessage' => 'Specified instance type is not valid.', ], [ 'errorCode' => 'InvalidPort.Malformed', 'errorMessage' => 'Specified port is not valid.', ], [ 'errorCode' => 'InvalidBackupRetentionPeriod.Malformed', 'errorMessage' => 'Specified backup retention period is not valid.', ], [ 'errorCode' => 'InvalidPreferredBackupTime.Format', 'errorMessage' => 'Specified preferred backup time is not valid.', ], [ 'errorCode' => 'InvalidPreferredBackupPeriod.Malformed', 'errorMessage' => 'Specified backup period is not valid.', ], [ 'errorCode' => 'InvalidOptmizationService', 'errorMessage' => 'Specified optmization service is not valid.', ], [ 'errorCode' => 'InvalidExpiredTime.Format', 'errorMessage' => 'Specified expired time is not valid.', ], [ 'errorCode' => 'InvalidSecurityIPList.Format', 'errorMessage' => 'Specified security IP list format is not valid.', ], [ 'errorCode' => 'InvalidSecurityIPList.Duplicate', 'errorMessage' => 'Specified security IP list is not valid: Duplicate IP address in the list', ], [ 'errorCode' => 'InvalidSecurityIPList.QuotaExceeded', 'errorMessage' => 'Specified security IP list is not valid: Exceeding the allowed amount of IP address in the list.', ], [ 'errorCode' => 'InvalidDBInstanceDescription.Format', 'errorMessage' => 'Specified DB instance description is not valid.', ], [ 'errorCode' => 'InvalidStorage.Format', 'errorMessage' => 'Specified Storage is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceConnType.Format', 'errorMessage' => 'Specified DB instance conn type is not valid.', ], [ 'errorCode' => 'PreCheckInvalid', 'errorMessage' => 'CreateDdrInstance PreCheck Is Invalid', ], [ 'errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance engine and type does not support operations.', ], [ 'errorCode' => 'InvalidRestoreType.Format', 'errorMessage' => 'Specified restore type is not valid.', ], [ 'errorCode' => 'NoBackupSetRegion', 'errorMessage' => 'BackupSetRegion is absence.', ], [ 'errorCode' => 'IncorrectBackupSetType', 'errorMessage' => 'Backup set type should be value ddr.', ], [ 'errorCode' => 'NoBaksetName', 'errorMessage' => 'BaksetName is absence.', ], [ 'errorCode' => 'NoSourceInstanceName', 'errorMessage' => 'No SourceDBInstanceName.', ], [ 'errorCode' => 'NoAvailableDisasterRestoreBakset', 'errorMessage' => 'No available disaster restore bakset.', ], [ 'errorCode' => 'InvalidBackupType.Format', 'errorMessage' => 'Specified backup type is not valid.', ], [ 'errorCode' => 'IncorrectEngineVersion', 'errorMessage' => 'Current engine version does not support operations.', ], [ 'errorCode' => 'DisasterRestoreRegionNotMatched', 'errorMessage' => 'Disaster restore should be operated in the ddr region or source region.', ], [ 'errorCode' => 'InvalidVpcIdRegion.NotSupported', 'errorMessage' => 'The Specified vSwitchId zone not supported.', ], [ 'errorCode' => 'VswitchIpExhausted', 'errorMessage' => 'No available ip in the specified vswitch.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'IncorrectBackupSetMethod', 'errorMessage' => 'Current backup set method does not support operations.', ], [ 'errorCode' => 'IncorrectBaksetVersion', 'errorMessage' => 'Current bakset version does not support operations.', ], [ 'errorCode' => 'CrossRegionUnsupportTDE', 'errorMessage' => 'Cross-region disaster restore not support TDE bakset.', ], [ 'errorCode' => 'OperationDenied.Resource', 'errorMessage' => 'Specified DB instance class or storage is not available in all Availability Zones.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidRegion.NotFound', 'errorMessage' => 'Specified Region does not exist in the RDS', ], [ 'errorCode' => 'InvalidClusterName.NotFound', 'errorMessage' => 'The specified cluster name is not available.', ], [ 'errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'Specified DB instance class is not found.', ], [ 'errorCode' => 'InvalidDBInstanceNetType.NotFound', 'errorMessage' => 'Specified DB instance net type is not found.', ], [ 'errorCode' => 'RestoreType.NotFound', 'errorMessage' => 'RestoreType is not found.', ], [ 'errorCode' => 'InvalidBackupSetID.NotFound', 'errorMessage' => 'Specified backup set ID does not exist.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"ConnectionString\\": \\"rm-****.mysql.rds.aliyuncs.com\\",\\n \\"DBInstanceId\\": \\"rm-****\\",\\n \\"OrderId\\": \\"2038691****\\",\\n \\"Port\\": \\"3306\\",\\n \\"RequestId\\": \\"E52666CC-330E-418A-8E5B-A19E3FB42D13\\"\\n}","errorExample":""},{"type":"xml","example":"\\n E52666CC-330E-418A-8E5B-A19E3FB42D13\\n rm-xxxxx\\n 3306\\n rm-xxxxx.mysql.rds.aliyuncs.com\\n 2038691xxxxx\\n","errorExample":""}]', 'title' => 'CreateDdrInstance', 'description' => '> Before restoration, you can call the CheckCreateDdrDBInstance operation to check whether a cross-region backup set can be used for cross-region restoration.'."\n" ."\n" .'### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> Before you call this operation, read the following topics and make sure that you fully understand the prerequisites and impacts of this operation.'."\n" ."\n" .'* [Use the cross-region backup feature for an ApsaraDB RDS for MySQL instance](~~120824~~)'."\n" .'* [Use the cross-region backup feature for an ApsaraDB RDS for PostgreSQL instance](~~206671~~)'."\n" .'* [Use the cross-region backup feature for an ApsaraDB RDS for SQL Server instance](~~187923~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ModifyInstanceCrossBackupPolicy' => [ 'summary' => 'Modifies the cross-region backup settings of an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5xxxxxxxxxx', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the source instance. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'CrossBackupType', 'in' => 'query', 'schema' => [ 'description' => 'The policy that is used to save the cross-region backup files of the instance. Set the value to **1**. The value 1 specifies that all cross-region backup files are saved.'."\n", 'type' => 'string', 'required' => false, 'example' => '1', ], ], [ 'name' => 'LogBackupEnabled', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable the cross-region log backup feature on the instance. Valid values:'."\n" ."\n" .'* **0**: disables the feature.'."\n" .'* **1:** enables the feature.'."\n" ."\n" .'> You can enable the cross-region log backup feature only when the cross-region backup feature is enabled.'."\n", 'type' => 'string', 'required' => false, 'example' => '1', ], ], [ 'name' => 'BackupEnabled', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable the cross-region backup feature on the instance. This parameter specifies whether you can back up data and logs. Valid values:'."\n" ."\n" .'* **0**: disables the feature.'."\n" .'* **1:** enables the feature.'."\n" ."\n" .'> Before you enable the cross-region backup feature, you must configure the CrossBackupRegion parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => '1', ], ], [ 'name' => 'CrossBackupRegion', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the region in which the cross-region backup files of the instance are stored.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai', ], ], [ 'name' => 'RetentType', 'in' => 'query', 'schema' => [ 'description' => 'The policy that is used to retain the cross-region backup files of the instance. Set the value to 1. The value **1** specifies that the cross-region backup files of the instance are retained based on the specified retention period.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'Retention', 'in' => 'query', 'schema' => [ 'description' => 'The number of days for which the cross-region backup files of the instance are retained. Valid values: **7 to 1825**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '7', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'BackupEnabled' => [ 'description' => 'The status of the cross-region backup feature on the instance. Valid values:'."\n" ."\n" .'* **Disable**'."\n" .'* **Enable**'."\n", 'type' => 'string', 'example' => 'Enable', ], 'CrossBackupRegion' => [ 'description' => 'The ID of the region in which the cross-region backup files of the instance are stored.'."\n", 'type' => 'string', 'example' => 'cn-shanghai', ], 'CrossBackupType' => [ 'description' => 'The policy that is used to save the cross-region backup files of the instance. Default value: **1**. The value 1 indicates that all cross-region backup files are saved.'."\n", 'type' => 'string', 'example' => '1', ], 'DBInstanceId' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5xxxxxxxxxx', ], 'LogBackupEnabled' => [ 'description' => 'The status of the cross-region log backup feature on the instance. Valid values:'."\n" ."\n" .'* **Disable**'."\n" .'* **Enable**'."\n", 'type' => 'string', 'example' => 'Enable', ], 'RegionId' => [ 'description' => 'The region ID of the source instance. You can call the [DescribeRegions](~~26243~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '50A6059D-6DBB-46C6-A851-1EE93C9013CF', ], 'RetentType' => [ 'description' => 'The policy that is used to retain the cross-region backup files of the instance. Default value: **1**. The value 1 indicates that the cross-region backup files of the instance are retained based on the specified retention period.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Retention' => [ 'description' => 'The number of days for which the cross-region backup files of the instance are retained. Valid values: **7 to 1825**.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '15', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'Specified parameter is not valid.', ], [ 'errorCode' => 'ParameterAbsence', 'errorMessage' => 'Necessary param is absence.', ], [ 'errorCode' => 'ParameterLeastAssociate', 'errorMessage' => 'Must input at least one optional parameter.', ], [ 'errorCode' => 'InvalidRegion.Format', 'errorMessage' => 'Specified Region is not valid.', ], [ 'errorCode' => 'OperationDenied.SwitchToCrossRegionBackup', 'errorMessage' => 'Snapshot backup does not support cross region backup storage at present.', ], [ 'errorCode' => 'OperationDenied.SwitchToSnapshot', 'errorMessage' => 'Snapshot backup does not support cross region storage at present. Please turn off cross region backup before switching to snapshot backup mode.', ], [ 'errorCode' => 'OperationDenied.SwitchSnapshotToPhysical', 'errorMessage' => 'Only physical backup to snapshot backup is supported.', ], [ 'errorCode' => 'UnsupportEncryptedSnapshot', 'errorMessage' => 'Encrypted DB instance snapshot does not support this operation.', ], [ 'errorCode' => 'DstRegionNoUser', 'errorMessage' => 'The user info wasn\'t found destination region, please access the purchase page to initiate registration.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'IncorrectEngineVersion', 'errorMessage' => 'Current engine version does not support operations.', ], [ 'errorCode' => 'IncorrectHostType', 'errorMessage' => 'Current DB Instance host type does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstanceEngine', 'errorMessage' => 'Current DB Instance engine does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', ], [ 'errorCode' => 'InvalidDdrStorage.NotFound', 'errorMessage' => 'Specified Ddr Storage does not exist or not support.', ], [ 'errorCode' => 'CrossBackupNotSupport', 'errorMessage' => 'Specified region not support cross region backup.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'Specified instance does not exist or not support.', ], [ 'errorCode' => 'InvalidPage.notFound', 'errorMessage' => 'Page not found.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"BackupEnabled\\": \\"Enable\\",\\n \\"CrossBackupRegion\\": \\"cn-shanghai\\",\\n \\"CrossBackupType\\": \\"1\\",\\n \\"DBInstanceId\\": \\"rm-uf6wjk5****\\",\\n \\"LogBackupEnabled\\": \\"Enable\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"RequestId\\": \\"50A6059D-6DBB-46C6-A851-1EE93C9013CF\\",\\n \\"RetentType\\": 1,\\n \\"Retention\\": 15\\n}","errorExample":""},{"type":"xml","example":"\\r\\n1\\r\\n\\tEnable\\r\\n\\tEnable\\r\\n\\tcn-shanghai\\r\\n\\t1\\r\\n\\t50A6059D-6DBB-46C6-A851-1EE93C9013CF\\r\\n\\trm-bpxxxxx\\r\\n\\tcn-hangzhou\\r\\n\\toss\\r\\n\\t\\r\\n\\t15\\r\\n","errorExample":""}]', 'title' => 'ModifyInstanceCrossBackupPolicy', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> Before you call this operation, read the following documentation and make sure that you fully understand the prerequisites and impacts of this operation.'."\n" ."\n" .'* [Use the cross-region backup feature of an ApsaraDB RDS for MySQL instance](~~120824~~)'."\n" .'* [Use the cross-region backup feature for an ApsaraDB RDS for PostgreSQL instance](~~206671~~)'."\n" .'* [Use the cross-region backup feature for an ApsaraDB RDS for SQL Server instance](~~187923~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeInstanceCrossBackupPolicy' => [ 'summary' => 'Queries the cross-region backup settings of an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5xxxxxxxxxx', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'BackupEnabled' => [ 'description' => 'The status of the cross-region backup feature on the instance. Valid values:'."\n" ."\n" .'* **Disable**'."\n" .'* **Enable**'."\n", 'type' => 'string', 'example' => 'Enable', ], 'BackupEnabledTime' => [ 'description' => 'The point in time at which the cross-region backup feature is enabled. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2019-06-12T05:44:21Z', ], 'CrossBackupRegion' => [ 'description' => 'The ID of the destination region where the cross-region backup files of the instance are stored.'."\n", 'type' => 'string', 'example' => 'cn-shanghai', ], 'CrossBackupType' => [ 'description' => 'The policy that is used to save the cross-region backup files of the instance. Default value: **1**. The value 1 indicates that all cross-region backup files are saved.'."\n", 'type' => 'string', 'example' => '1', ], 'DBInstanceDescription' => [ 'description' => 'The name of the instance. It must be 2 to 256 characters in length. The value can contain letters, digits, underscores (\\_), and hyphens (-), and must start with a letter.'."\n" ."\n" .'> The value cannot start with http:// or https://.'."\n", 'type' => 'string', 'example' => 'Test database'."\n", ], 'DBInstanceId' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5xxxxxxxxxx', ], 'DBInstanceStatus' => [ 'description' => 'The status of the instance. For more information, see [Instance state table](~~26315~~).'."\n", 'type' => 'string', 'example' => 'Running', ], 'Engine' => [ 'description' => 'The database engine of the instance.'."\n", 'type' => 'string', 'example' => 'mysql', ], 'EngineVersion' => [ 'description' => 'The database engine version.'."\n", 'type' => 'string', 'example' => '5.6', ], 'LockMode' => [ 'description' => 'The lock status of the instance. Valid values:'."\n" ."\n" .'* **Unlock**: The instance is not locked.'."\n" .'* **ManualLock**: The instance is manually locked.'."\n" .'* **LockByExpiration**: The instance is automatically locked due to instance expiration.'."\n" .'* **LockByRestoration**: The instance is automatically locked before a rollback.'."\n" .'* **LockByDiskQuota**: The instance is automatically locked because its storage capacity is exhausted and the instance is inaccessible.'."\n", 'type' => 'string', 'example' => 'Unlock', ], 'LogBackupEnabled' => [ 'description' => 'The status of the cross-region log backup feature on the instance. Valid values:'."\n" ."\n" .'* **Disable**'."\n" .'* **Enable**'."\n", 'type' => 'string', 'example' => 'Enable', ], 'LogBackupEnabledTime' => [ 'description' => 'The time when cross-region log backup was enabled on the instance. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2019-06-12T05:44:21Z', ], 'RegionId' => [ 'description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'CB7667B2-72C8-497B-9BD8-3B343CEF51AB', ], 'RetentType' => [ 'description' => 'The policy that is used to retain the cross-region backup files of the instance. Default value: **1**. The value 1 indicates that the cross-region backup files of the instance are retained based on the specified retention period.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Retention' => [ 'description' => 'The number of days for which the cross-region backup files of the instance are retained. Valid values: **7 to 1825**.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '15', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidRegion.Format', 'errorMessage' => 'Specified Region is not valid.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'CrossBackupNotSupport', 'errorMessage' => 'Specified region not support cross region backup.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidPage.notFound', 'errorMessage' => 'Page not found.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"BackupEnabled\\": \\"Enable\\",\\n \\"BackupEnabledTime\\": \\"2019-06-12T05:44:21Z\\",\\n \\"CrossBackupRegion\\": \\"cn-shanghai\\",\\n \\"CrossBackupType\\": \\"1\\",\\n \\"DBInstanceDescription\\": \\"testdb\\",\\n \\"DBInstanceId\\": \\"rm-uf6wjk5****\\",\\n \\"DBInstanceStatus\\": \\"Running\\",\\n \\"Engine\\": \\"mysql\\",\\n \\"EngineVersion\\": \\"5.6\\",\\n \\"LockMode\\": \\"Unlock\\",\\n \\"LogBackupEnabled\\": \\"Enable\\",\\n \\"LogBackupEnabledTime\\": \\"2019-06-12T05:44:21Z\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"RequestId\\": \\"CB7667B2-72C8-497B-9BD8-3B343CEF51AB\\",\\n \\"RetentType\\": 1,\\n \\"Retention\\": 15\\n}","errorExample":""},{"type":"xml","example":"\\r\\nACTIVATION\\r\\n\\tUnlock\\r\\n\\t2019-06-12T05:44:21Z\\r\\n\\t1\\r\\n\\tEnable\\r\\n\\tEnable\\r\\n\\t1\\r\\n\\trm-bpxxxxx\\r\\n\\t\\r\\n\\t15\\r\\n\\tmysql\\r\\n\\t2019-06-12T05:44:21Z\\r\\n\\tcn-shanghai\\r\\n\\trds\\r\\n\\tcn-hangzhou\\r\\n\\tCB7667B2-72C8-497B-9BD8-3B343CEF51AB\\r\\n\\t5.6\\r\\n\\toss\\r\\n\\t\\r\\n\\t1\\r\\n","errorExample":""}]', 'title' => 'DescribeInstanceCrossBackupPolicy', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.'."\n" ."\n" .'* [Use the cross-region backup feature for an ApsaraDB RDS for MySQL instance](~~120824~~)'."\n" .'* [Use the cross-region backup feature for an ApsaraDB RDS for PostgreSQL instance](~~206671~~)'."\n" .'* [Use the cross-region backup feature for an ApsaraDB RDS for SQL Server instance](~~187923~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeCrossBackupMetaList' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'BackupSetId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the cross-region backup file that you want to use. You can call the [DescribeCrossRegionBackups](~~121733~~) operation to query the ID of the cross-region backup file.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123456', ], ], [ 'name' => 'GetDbName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the database that you want to query. The system implements exact match based on the value of this parameter and returns the name of the matched database and the names of the tables in the matched database.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testdb1', ], ], [ 'name' => 'Pattern', 'in' => 'query', 'schema' => [ 'description' => 'The name of the database that you want to query. The system implements fuzzy match based on the value of this parameter and returns only the name of the matched database.'."\n" ."\n" .'> You can implement fuzzy match and then exact match. For example, you can set the Pattern parameter to test to query the testdb1 and testdb2 databases. Then, you can specify the **GetDbName** parameter to query only the matched database and the tables in the matched database.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return per page. Default value: **1**.'."\n" ."\n" .'> This parameter only takes effect when you specify the **PageIndex** parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => '30', ], ], [ 'name' => 'PageIndex', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Valid values: any non-zero positive integer.'."\n" ."\n" .'> This parameter only takes effect when you specify the **PageSize** parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => '1', ], ], [ 'name' => 'Region', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy*****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'DBInstanceName' => [ 'description' => 'The instance to which the cross-region backup file belongs.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5xxxxxxx', ], 'Items' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Meta' => [ 'description' => 'An array that consists of the information about the databases and tables whose data is included in the cross-region backup file.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Database' => [ 'description' => 'The name of the database.'."\n", 'type' => 'string', 'example' => 'testdb1', ], 'Size' => [ 'description' => 'The size of the table. Unit: KB. If the database contains more than one table, the names of these tables are separated by commas (,).'."\n", 'type' => 'string', 'example' => '1000', ], 'Tables' => [ 'description' => 'An array that consists of the names of the tables that the database contains. If the database contains more than one table, the names of these tables are separated by commas (,).'."\n", 'type' => 'string', 'example' => 'test1,test2', ], ], ], ], ], ], 'PageNumber' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageRecordCount' => [ 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '60F9A12A-16B8-4728-B099-4CA38D32C31C', ], 'TotalPageCount' => [ 'description' => 'The total number of pages returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'TotalRecordCount' => [ 'description' => 'The total number of returned entries.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'NoAvailableDisasterRestoreBakset', 'errorMessage' => 'No available disaster restore bakset', ], [ 'errorCode' => 'InvalidPageSize', 'errorMessage' => 'The page size is invalid', ], [ 'errorCode' => 'InvalidPageIndex', 'errorMessage' => 'The page index is invalid', ], [ 'errorCode' => 'InvalidRestoreTime.Format', 'errorMessage' => 'Specified restore time is not valid.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'InvalidMeta.Empty', 'errorMessage' => 'Meta information is empty.', ], [ 'errorCode' => 'InvalidMeta.TooLarge', 'errorMessage' => 'Meta information is too large.', ], [ 'errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', ], [ 'errorCode' => 'IncorrectEngineVersion', 'errorMessage' => 'Current engine version does not support operations.', ], [ 'errorCode' => 'InvalidBackupLogStatus', 'errorMessage' => 'Current backup log enable status does not support this operation.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidBackupSetID.NotFound', 'errorMessage' => 'Specified backup set ID does not exist.', ], [ 'errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'Specified parameter({}) is not valid.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBInstanceName\\": \\"rm-uf6wjk5****\\",\\n \\"Items\\": {\\n \\"Meta\\": [\\n {\\n \\"Database\\": \\"testdb1\\",\\n \\"Size\\": \\"1000\\",\\n \\"Tables\\": \\"test1,test2\\"\\n }\\n ]\\n },\\n \\"PageNumber\\": 1,\\n \\"PageRecordCount\\": 1,\\n \\"RequestId\\": \\"60F9A12A-16B8-4728-B099-4CA38D32C31C\\",\\n \\"TotalPageCount\\": 1,\\n \\"TotalRecordCount\\": 1\\n}","errorExample":""},{"type":"xml","example":"\\n1\\n1\\n60F9A12A-16B8-4728-B099-4CA38D32C31C\\n1\\n\\n \\n 4320\\n 5\\n testdb1\\n test1\\n test2\\n \\n\\nrm-uf6wjk5xxxxxxx\\n","errorExample":""}]', 'title' => 'DescribeCrossBackupMetaList', 'summary' => 'Queries the databases and tables whose data is included in a cross-region backup file of an instance.', 'description' => 'ApsaraDB RDS for MySQL instances support cross-region backup and restoration. For more information, see [Back up an ApsaraDB RDS for MySQL instance across regions](~~120824~~) and [Restore the data of an ApsaraDB RDS for MySQL instance across regions](~~120875~~).'."\n" ."\n" .'Before you call this operation, make sure that the instance runs one of the following database engines:'."\n" ."\n" .'* MySQL. For more information, see [Back up an ApsaraDB RDS for MySQL instance across regions](~~120824~~).'."\n" .'* SQL Server. For more information, see [Back up an ApsaraDB RDS for SQL Server instance across regions](~~187923~~).'."\n" .'* PostgreSQL. For more information, see [Enable cross-region backups for an ApsaraDB RDS for PostgreSQL instance](~~206671~~).'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeCrossRegionBackups' => [ 'summary' => 'Queries the cross-region data backup files of an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5xxxxxxxxxx', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'CrossBackupRegion', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the region in which the cross-region data backup file is stored.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai', ], ], [ 'name' => 'CrossBackupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the cross-region data backup file.'."\n" ."\n" .'> You must specify the **CrossBackupId** parameter. Alternatively, you must specify the **StartTime** and **EndTime** parameters.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '14562', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => false, 'example' => '2019-05-30T12:10:00Z', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => 'The end of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => false, 'example' => '2019-06-15T12:10:00Z', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page. Valid values:'."\n" ."\n" .'* **30**'."\n" .'* **50**'."\n" .'* **100**'."\n" ."\n" .'Default value: 30.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => 'The page number. Valid values: any non-zero positive integer.'."\n" ."\n" .'Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'BackupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the backup file.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '603524***', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy*****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'EndTime' => [ 'description' => 'The end of the time range to query.'."\n", 'type' => 'string', 'example' => '2019-06-15T12:10:00Z', ], 'Items' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Item' => [ 'description' => 'The cross-region data backup files.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'BackupEndTime' => [ 'description' => 'The time when the cross-region data backup file was generated.'."\n", 'type' => 'string', 'example' => '2019-06-15T12:10:00Z', ], 'BackupMethod' => [ 'description' => 'The method that is used to generate the cross-region data backup file. Valid values:'."\n" ."\n" .'* **L**: logical backup'."\n" .'* **P**: physical backup'."\n", 'type' => 'string', 'example' => 'P', ], 'BackupSetScale' => [ 'description' => 'The level at which the cross-region data backup file is generated.'."\n" ."\n" .'* **0**: instance-level backup'."\n" .'* **1**: database-level backup'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'BackupSetStatus' => [ 'description' => 'The status of the cross-region data backup. Valid values:'."\n" ."\n" .'* **0**: The cross-region data backup is successful.'."\n" .'* **1**: The cross-region data backup failed.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'BackupStartTime' => [ 'description' => 'The time when the cross-region data backup started.'."\n", 'type' => 'string', 'example' => '2019-05-30T12:10:00Z', ], 'BackupType' => [ 'description' => 'The type of the cross-region data backup. Valid values:'."\n" ."\n" .'* **F**: full data backup'."\n" .'* **I**: incremental data backup'."\n", 'type' => 'string', 'example' => 'F', ], 'Category' => [ 'description' => 'The RDS edition of the instance. Valid values:'."\n" ."\n" .'* **Basic**: RDS Basic Edition.'."\n" .'* **HighAvailability**: RDS High-availability Edition.'."\n" .'* **Finance**: RDS Enterprise Edition. This edition is available only for the China site (aliyun.com).'."\n", 'type' => 'string', 'example' => 'HighAvailability', ], 'ConsistentTime' => [ 'description' => 'The point in time that is indicated by the data in the cross-region data backup file.'."\n", 'type' => 'string', 'example' => '2019-06-12T05:44:46Z', ], 'CrossBackupDownloadLink' => [ 'description' => 'The external URL from which you can download the cross-region data backup file.'."\n", 'type' => 'string', 'example' => 'http://rdsddrbak-shanghai.oss-cn-shanghai.aliyuncs.com/xxxxx', ], 'CrossBackupId' => [ 'description' => 'The ID of the cross-region data backup file.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '14377', ], 'CrossBackupRegion' => [ 'description' => 'The ID of the region in which the cross-region backup files of the instance are stored.'."\n", 'type' => 'string', 'example' => 'cn-shanghai', ], 'CrossBackupSetFile' => [ 'description' => 'The name of the compressed package that contains the cross-region data backup file.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou_rm-xxxxx_hins81xxx_data_20190612134426_qp.xb', ], 'CrossBackupSetLocation' => [ 'description' => 'The location where the cross-region data backup file is stored.'."\n", 'type' => 'string', 'example' => 'oss', ], 'CrossBackupSetSize' => [ 'description' => 'The size of the cross-region data backup file. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '5312836', ], 'DBInstanceStorageType' => [ 'description' => 'The storage type. Valid values:'."\n" ."\n" .'* **local_ssd**: local SSDs. This is the recommended storage type.'."\n" .'* **cloud_ssd**: standard SSD.'."\n" .'* **cloud_essd**: enhanced SSD (ESSD).'."\n", 'type' => 'string', 'example' => 'ssd', ], 'Engine' => [ 'description' => 'The database engine of the instance.'."\n", 'type' => 'string', 'example' => 'mysql', ], 'EngineVersion' => [ 'description' => 'The database engine version.'."\n", 'type' => 'string', 'example' => '5.6', ], 'InstanceId' => [ 'description' => 'The instance ID. This parameter is used to determine whether the instance that generates the cross-region data backup file is a primary or secondary instance.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '8161055', ], 'RestoreRegions' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'RestoreRegion' => [ 'description' => 'The regions to which the cross-region data backup file can be restored.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The region to which the cross-region data backup file can be restored.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], ], ], ], ], ], ], ], ], 'PageNumber' => [ 'description' => 'The page number. Pages start from page 1.'."\n" ."\n" .'Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageRecordCount' => [ 'description' => 'The number of cross-region data backup files on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', ], 'RegionId' => [ 'description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '60912B41-7579-4B5D-B289-8856030F0A6A', ], 'StartTime' => [ 'description' => 'The beginning of the time range to query.'."\n", 'type' => 'string', 'example' => '2019-05-30T12:10:00Z', ], 'TotalRecordCount' => [ 'description' => 'The total number of entries that are returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'ParameterAbsence', 'errorMessage' => 'Necessary param is absence.', ], [ 'errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'Specified parameter is not valid.', ], [ 'errorCode' => 'InvalidRegion.Format', 'errorMessage' => 'Specified Region is not valid.', ], [ 'errorCode' => 'InvalidStartTime.Format', 'errorMessage' => 'Specified start time is not valid.', ], [ 'errorCode' => 'InvalidEndTime.Format', 'errorMessage' => 'Specified end time is not valid.', ], [ 'errorCode' => 'InvalidTime.Format', 'errorMessage' => 'Specified time is not valid.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'CrossBackupNotSupport', 'errorMessage' => 'Specified region not support cross region backup.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidPage.notFound', 'errorMessage' => 'Page not found.', ], [ 'errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'Specified instance does not exist or not support.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"EndTime\\": \\"2019-06-15T12:10:00Z\\",\\n \\"Items\\": {\\n \\"Item\\": [\\n {\\n \\"BackupEndTime\\": \\"2024-03-05T02:23:37Z\\",\\n \\"BackupMethod\\": \\"P\\",\\n \\"BackupSetScale\\": 0,\\n \\"BackupSetStatus\\": 0,\\n \\"BackupStartTime\\": \\"2024-03-05T02:22:45Z\\",\\n \\"BackupType\\": \\"F\\",\\n \\"Category\\": \\"HighAvailability\\",\\n \\"ConsistentTime\\": \\"2024-03-05T02:22:54Z\\",\\n \\"CrossBackupDownloadLink\\": \\"http://rdsddrbak-shanghai.oss-cn-shanghai.aliyuncs.com/****\\",\\n \\"CrossBackupId\\": 0,\\n \\"CrossBackupRegion\\": \\"cn-shanghai\\",\\n \\"CrossBackupSetFile\\": \\"cn-hangzhou_rm-****_hins81xxx_data_20190612134426_qp.xb\\",\\n \\"CrossBackupSetLocation\\": \\"oss\\",\\n \\"CrossBackupSetSize\\": 5312836,\\n \\"DBInstanceStorageType\\": \\"ssd\\",\\n \\"Engine\\": \\"mysql\\",\\n \\"EngineVersion\\": \\"5.6\\",\\n \\"InstanceId\\": 0,\\n \\"RestoreRegions\\": {\\n \\"RestoreRegion\\": [\\n \\"\\\\\\"cn-hangzhou\\\\\\", \\\\\\"cn-shanghai\\\\\\"\\"\\n ]\\n }\\n }\\n ]\\n },\\n \\"PageNumber\\": 1,\\n \\"PageRecordCount\\": 30,\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"RequestId\\": \\"60912B41-7579-4B5D-B289-8856030F0A6A\\",\\n \\"StartTime\\": \\"2019-05-30T12:10:00Z\\",\\n \\"TotalRecordCount\\": 100\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n\\t\\t\\r\\n\\t\\t\\tcn-hangzhou_rm-bpxxxxx_hins798xxxx_data_20190611125201.tar.gz\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\tF\\r\\n\\t\\t\\t7980000\\r\\n\\t\\t\\t14358\\r\\n\\t\\t\\t2019-06-11T04:55:02Z\\r\\n\\t\\t\\tP\\r\\n\\t\\t\\toss\\r\\n\\t\\t\\t2179643\\r\\n\\t\\t\\tmysql\\r\\n\\t\\t\\t2019-06-11T04:52:46Z\\r\\n\\t\\t\\thttp://rdsddrbak-zb.oss-cn-zhangjiakou.aliyuncs.com/cn-hangzhou_rm-bpxxxxx_hins7986073_data_20190611125201.tar.gz?OSSAccessKeyId=LTAxxxxx&Expires=1560501641&Signature=laK0kxxxxx%3D\\r\\n\\t\\t\\tHighAvailability\\r\\n\\t\\t\\tcn-zhangjiakou\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\tcn-hangzhou\\r\\n\\t\\t\\t\\tcn-zhangjiakou\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t5.7\\r\\n\\t\\t\\tssd\\r\\n\\t\\t\\r\\n\\t\\r\\n\\t1\\r\\n\\t1\\r\\n\\t60912B41-7579-4B5D-B289-8856030F0A6A\\r\\n\\tcn-hangzhou\\r\\n\\t2019-06-11T08:00:00Z\\r\\n\\t2019-06-10T00:00:00Z\\r\\n\\t30\\r\\n ","errorExample":""}]', 'title' => 'DescribeCrossRegionBackups', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* ApsaraDB RDS for MySQL instances with local disks'."\n" .'* RDS PostgreSQL'."\n" .'* RDS SQL Server'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.'."\n" ."\n" .'* [Use the cross-region backup feature for an ApsaraDB RDS for MySQL instance](~~120824~~)'."\n" .'* [Use the cross-region backup feature for an ApsaraDB RDS for SQL Server instance](~~187923~~)'."\n" .'* [Use the cross-region backup feature for an ApsaraDB RDS for PostgreSQL instance](~~206671~~)'."\n" ."\n" .'> For more information about how to query cross-region log backup files, see DescribeCrossRegionLogBackupFiles.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeCrossRegionLogBackupFiles' => [ 'summary' => 'Queries the cross-region log backup files of an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5xxxxxxxxxx', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'CrossBackupRegion', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the destination region within which the cross-region backup file is stored. You can call the DescribeCrossRegionBackupDBInstance operation to query the region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2019-05-30T12:10:00Z', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => 'The end of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2019-06-15T12:10:00Z', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Valid values:'."\n" ."\n" .'* **30**'."\n" .'* **50**'."\n" .'* **100**'."\n" ."\n" .'Default value: 30.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => 'The page number. Valid values: any non-zero positive integer.'."\n" ."\n" .'Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'DBInstanceId' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5xxxxxxxxxx', ], 'EndTime' => [ 'description' => 'The end of the time range to query. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2019-06-15T12:10:00Z', ], 'Items' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Item' => [ 'description' => 'The cross-region log backup files.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'CrossBackupRegion' => [ 'description' => 'The ID of the destination region within which the cross-region backup file is stored.'."\n", 'type' => 'string', 'example' => 'cn-shanghai', ], 'CrossDownloadLink' => [ 'description' => 'The external URL from which you can download the cross-region log backup file.'."\n", 'type' => 'string', 'example' => 'http://rdsddrlog-zb.oss-cn-zhangjiakou.aliyuncs.com/xxxxx', ], 'CrossIntranetDownloadLink' => [ 'description' => 'The internal URL from which you can download the cross-region log backup file.'."\n", 'type' => 'string', 'example' => 'http://rdsddrlog-zb.oss-cn-zhangjiakou-internal.aliyuncs.com/xxxxx', ], 'CrossLogBackupId' => [ 'description' => 'The ID of the cross-region log backup file.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '14567', ], 'CrossLogBackupSize' => [ 'description' => 'The size of the cross-region log backup file. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '5312836', ], 'InstanceId' => [ 'description' => 'The instance ID.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '8161055', ], 'LinkExpiredTime' => [ 'description' => 'The time when the URL expires. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2019-06-30T15:00:00Z', ], 'LogBeginTime' => [ 'description' => 'The start time of the cross-region log backup file. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2019-05-30T12:10:00Z', ], 'LogEndTime' => [ 'description' => 'The end time of the cross-region log backup file. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2019-05-30T20:10:00Z', ], 'LogFileName' => [ 'description' => 'The name of the cross-region log backup file.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou_rm-bpxxxxx_7198739_mysql-bin.000230', ], ], ], ], ], ], 'PageNumber' => [ 'description' => 'The page number. Pages start from page 1.'."\n" ."\n" .'Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageRecordCount' => [ 'description' => 'The number of cross-region backup files on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', ], 'RegionId' => [ 'description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'DAC241E8-28E6-49DA-BFB0-B2DD090885C1', ], 'StartTime' => [ 'description' => 'The beginning of the time range to query. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2019-05-30T12:10:00Z', ], 'TotalRecordCount' => [ 'description' => 'The total number of entries that are returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'ParameterAbsence', 'errorMessage' => 'Necessary param is absence.', ], [ 'errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'Specified parameter is not valid.', ], [ 'errorCode' => 'InvalidRegion.Format', 'errorMessage' => 'Specified Region is not valid.', ], [ 'errorCode' => 'InvalidStartTime.Format', 'errorMessage' => 'Specified start time is not valid.', ], [ 'errorCode' => 'InvalidEndTime.Format', 'errorMessage' => 'Specified end time is not valid.', ], [ 'errorCode' => 'InvalidTime.Format', 'errorMessage' => 'Specified time is not valid.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'CrossBackupNotSupport', 'errorMessage' => 'Specified region not support cross region backup.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'Specified instance does not exist or not support.', ], [ 'errorCode' => 'InvalidPage.notFound', 'errorMessage' => 'Page not found.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBInstanceId\\": \\"rm-uf6wjk5****\\",\\n \\"EndTime\\": \\"2019-06-15T12:10:00Z\\",\\n \\"Items\\": {\\n \\"Item\\": [\\n {\\n \\"CrossBackupRegion\\": \\"cn-shanghai\\",\\n \\"CrossDownloadLink\\": \\"http://rdsddrlog-zb.oss-cn-zhangjiakou.aliyuncs.com/****\\",\\n \\"CrossIntranetDownloadLink\\": \\"http://rdsddrlog-zb.oss-cn-zhangjiakou-internal.aliyuncs.com/****\\",\\n \\"CrossLogBackupId\\": 14567,\\n \\"CrossLogBackupSize\\": 5312836,\\n \\"InstanceId\\": 8161055,\\n \\"LinkExpiredTime\\": \\"2019-06-30T15:00:00Z\\",\\n \\"LogBeginTime\\": \\"2019-05-30T12:10:00Z\\",\\n \\"LogEndTime\\": \\"2019-05-30T20:10:00Z\\",\\n \\"LogFileName\\": \\"cn-hangzhou_rm-bp****_7198739_mysql-bin.000230\\"\\n }\\n ]\\n },\\n \\"PageNumber\\": 1,\\n \\"PageRecordCount\\": 30,\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"RequestId\\": \\"DAC241E8-28E6-49DA-BFB0-B2DD090885C1\\",\\n \\"StartTime\\": \\"2019-05-30T12:10:00Z\\",\\n \\"TotalRecordCount\\": 100\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n\\t\\t\\r\\n\\t\\t\\t2019-06-02T07:36:18Z\\r\\n\\t\\t\\tcn-zhangjiakou\\r\\n\\t\\t\\t2019-06-01T06:11:49Z\\r\\n\\t\\t\\t2019-06-01T00:11:44Z\\r\\n\\t\\t\\t7198743\\r\\n\\t\\t\\t770014\\r\\n\\t\\t\\thttp://rdsddrlog-zb.oss-cn-zhangjiakou.aliyuncs.com/xxxxxx\\r\\n\\t\\t\\thttp://rdsddrlog-zb.oss-cn-zhangjiakou-internal.aliyuncs.com/xxxxx\\r\\n\\t\\t\\r\\n\\t\\r\\n\\t1\\r\\n\\t52\\r\\n\\trm-xxxxx\\r\\n\\tcn-hangzhou\\r\\n\\tA9723BCE-F32F-4F05-9922-8371C0842FA7\\r\\n\\tEndTime=2019-06-15T12:10:00Z\\r\\n\\t2019-05-30T12:10:00Z\\r\\n\\t10\\r\\n","errorExample":""}]', 'title' => 'DescribeCrossRegionLogBackupFiles', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.'."\n" ."\n" .'* [Use the cross-region backup feature for an ApsaraDB RDS for MySQL instance](~~120824~~)'."\n" .'* [Use the cross-region backup feature for an ApsaraDB RDS for SQL Server instance](~~187923~~)'."\n" .'* [Use the cross-region backup feature for an ApsaraDB RDS for PostgreSQL instance](~~206671~~)'."\n" ."\n" .'> For more information about how to query cross-region data backup files, see [DescribeCrossRegionBackups](~~121733~~).'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeAvailableCrossRegion' => [ 'summary' => 'Queries the available destination regions to which the cross-region backup files from a specific source region can be replicated.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the DescribeRegions operation to query the most recent zone list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Regions' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Region' => [ 'description' => 'An array that consists of destination regions for cross-region backups.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The list of destination regions that support cross-region backup.'."\n", 'type' => 'string', 'example' => '"cn-qingdao","cn-shanghai", "cn-shenzhen"', ], ], ], ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '39265F46-EC77-4036-8AC4-F035F32F6BE2', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidRegion.Format', 'errorMessage' => 'Specified Region is not valid.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'CrossBackupNotSupport', 'errorMessage' => 'Specified region not support cross region backup.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidPage.notFound', 'errorMessage' => 'Page not found.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Regions\\": {\\n \\"Region\\": [\\n \\"\\\\\\"cn-qingdao\\\\\\",\\\\\\"cn-shanghai\\\\\\", \\\\\\"cn-shenzhen\\\\\\"\\"\\n ]\\n },\\n \\"RequestId\\": \\"39265F46-EC77-4036-8AC4-F035F32F6BE2\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n39265F46-EC77-4036-8AC4-F035F32F6BE2\\r\\n\\t\\r\\n\\t\\tcn-qingdao\\r\\n\\t\\tcn-shanghai\\r\\n\\t\\tcn-shenzhen\\r\\n\\t\\r\\n","errorExample":""}]', 'title' => 'DescribeAvailableCrossRegion', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.'."\n" ."\n" .'* [Use the cross-region backup feature of an ApsaraDB RDS for MySQL instance](~~120824~~)'."\n" .'* [Use the cross-region backup feature for an ApsaraDB RDS for PostgreSQL instance](~~206671~~)'."\n" .'* [Use the cross-region backup feature for an ApsaraDB RDS for SQL Server instance](~~187923~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeAvailableRecoveryTime' => [ 'summary' => 'Queries the time range within which data can be restored from a cross-region backup file.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'CrossBackupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the cross-region data backup file. You can call the DescribeCrossRegionBackups operation to query the backup file ID.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '14***', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy*****', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rm-uf6wjk5*****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'CrossBackupId' => [ 'description' => 'The ID of the cross-region data backup file.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '14377', ], 'RecoveryBeginTime' => [ 'description' => 'The start time from which data can be restored. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2019-06-12T05:22:29Z', ], 'RecoveryEndTime' => [ 'description' => 'The end time to which data can be restored. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2019-06-12T07:33:12Z', ], 'RegionId' => [ 'description' => 'The region where the source instance resides.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '8CCBF4BA-7CE1-47E1-B49F-E97EA200A40D', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'NoAvailableLogBackup', 'errorMessage' => 'No available log backup.', ], [ 'errorCode' => 'NoAvailableDisasterRestoreBakset', 'errorMessage' => 'No available disaster restore bakset.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'CrossBackupNotSupport', 'errorMessage' => 'Specified region not support cross region backup.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidBackupSetID.NotFound', 'errorMessage' => 'Specified backup set ID does not exist.', ], [ 'errorCode' => 'InvalidPage.notFound', 'errorMessage' => 'Page not found.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"CrossBackupId\\": 0,\\n \\"RecoveryBeginTime\\": \\"2024-03-04T21:00:47Z\\",\\n \\"RecoveryEndTime\\": \\"2024-03-07T02:23:26Z\\",\\n \\"RegionId\\": \\"cn-chengdu\\",\\n \\"RequestId\\": \\"8CCBF4BA-7CE1-47E1-B49F-E97EA200A40D\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n2019-06-12T07:33:12Z\\r\\n\\t2019-06-12T05:22:29Z\\r\\n\\t8CCBF4BA-7CE1-47E1-B49F-E97EA200A40D\\r\\n\\tcn-hangzhou\\r\\n\\t14377\\r\\n","errorExample":""}]', 'title' => 'DescribeAvailableRecoveryTime', 'description' => '> To view the time range within which you can restore data from a standard backup set, see DescribeBackups.'."\n" ."\n" .'### [](#)Supported database engines'."\n" ."\n" .'ApsaraDB RDS for MySQL instances with local disks'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.'."\n" ."\n" .'[Use the cross-region backup feature](~~120824~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeCrossRegionBackupDBInstance' => [ 'summary' => 'Queries the instances for which the cross-region backup feature is enabled in a region and the cross-region backup settings of these instances.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the region.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. Up to 30 instance IDs are allowed in a single request. If you enter more than one instance ID, separate them with commas (,).'."\n", 'type' => 'string', 'required' => false, 'example' => 'rm-uf6wjk5xxxxxxxxxx', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return per page. Default value: 30.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Valid values: any non-zero positive integer.'."\n" ."\n" .'Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Items' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Item' => [ 'description' => 'The cross-region backup settings.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'BackupEnabled' => [ 'description' => 'The status of the cross-region backup feature on the instance. Valid values:'."\n" ."\n" .'* **Disable**'."\n" .'* **Enable**'."\n", 'type' => 'string', 'example' => 'Enable', ], 'BackupEnabledTime' => [ 'description' => 'The time when cross-region backup was enabled on the instance. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2019-06-12T05:44:21Z', ], 'CrossBackupRegion' => [ 'description' => 'The ID of the destination region within which the cross-region backup file is stored.'."\n", 'type' => 'string', 'example' => 'cn-shanghai', ], 'CrossBackupType' => [ 'description' => 'The policy that is used to save the cross-region backup files of the instance. Default value: **1**. The value 1 indicates that all cross-region backup files are saved.'."\n", 'type' => 'string', 'example' => '1', ], 'DBInstanceDescription' => [ 'description' => 'The name of the instance. It must be 2 to 256 characters in length. The value can contain letters, digits, underscores (\\_), and hyphens (-), and must start with a letter.'."\n" ."\n" .'> The value cannot start with http:// or https://.'."\n", 'type' => 'string', 'example' => 'Test database'."\n", ], 'DBInstanceId' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5xxxxxxxxxx', ], 'DBInstanceStatus' => [ 'description' => 'The instance status. For more information, see [Instance statuses](~~26315~~).'."\n", 'type' => 'string', 'example' => 'Running', ], 'Engine' => [ 'description' => 'The database engine of the instance.'."\n", 'type' => 'string', 'example' => 'MySQL', ], 'EngineVersion' => [ 'description' => 'The database engine version.'."\n", 'type' => 'string', 'example' => '5.6', ], 'LockMode' => [ 'description' => 'The lock status of the instance. Valid values:'."\n" ."\n" .'* **Unlock**: The instance is not locked.'."\n" .'* **ManualLock**: The instance is manually locked.'."\n" .'* **LockByExpiration**: The instance is automatically locked after it expires.'."\n" .'* **LockByRestoration**: The instance is automatically locked before it is rolled back.'."\n" .'* **LockByDiskQuota**: The instance is automatically locked because its storage capacity is exhausted and the instance is inaccessible.'."\n", 'type' => 'string', 'example' => 'Unlock', ], 'LogBackupEnabled' => [ 'description' => 'The status of the cross-region log backup feature on the instance. Valid values:'."\n" ."\n" .'* **Disable**'."\n" .'* **Enable**'."\n", 'type' => 'string', 'example' => 'Enable', ], 'LogBackupEnabledTime' => [ 'description' => 'The time when the cross-region log backup feature was enabled on the instance. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2019-06-12T05:44:21Z', ], 'RetentType' => [ 'description' => 'The policy that is used to retain the cross-region backup files of the instance. Cross-region backups can be retained only based on the specified retention period. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Retention' => [ 'description' => 'The number of days for which the cross-region backup files of the instance are retained. Valid values: **7 to 1825**.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '15', ], ], ], ], ], ], 'ItemsNumbers' => [ 'description' => 'The total number of items returned for cross-region backup settings.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageNumber' => [ 'description' => 'The page number. Pages start from page 1.'."\n" ."\n" .'Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries per page. Default value: 30.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', ], 'RegionId' => [ 'description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '33517002-182D-40BE-93EC-610BD3381045', ], 'TotalRecords' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'Specified parameter is not valid.', ], [ 'errorCode' => 'InvalidRegion.Format', 'errorMessage' => 'Specified Region is not valid.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'CrossBackupNotSupport', 'errorMessage' => 'Specified region not support cross region backup.', ], [ 'errorCode' => 'IncorrectDBInstanceEngine', 'errorMessage' => 'Current DB Instance engine does not support this operation.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidPage.notFound', 'errorMessage' => 'Page not found.', ], [ 'errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'Specified user does not exist.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Items\\": {\\n \\"Item\\": [\\n {\\n \\"BackupEnabled\\": \\"Enable\\",\\n \\"BackupEnabledTime\\": \\"2019-06-12T05:44:21Z\\",\\n \\"CrossBackupRegion\\": \\"cn-shanghai\\",\\n \\"CrossBackupType\\": \\"1\\",\\n \\"DBInstanceDescription\\": \\"testdb\\",\\n \\"DBInstanceId\\": \\"rm-uf6wjk5****\\",\\n \\"DBInstanceStatus\\": \\"Running\\",\\n \\"Engine\\": \\"MySQL\\",\\n \\"EngineVersion\\": \\"5.6\\",\\n \\"LockMode\\": \\"Unlock\\",\\n \\"LogBackupEnabled\\": \\"Enable\\",\\n \\"LogBackupEnabledTime\\": \\"2019-06-12T05:44:21Z\\",\\n \\"RetentType\\": 1,\\n \\"Retention\\": 15\\n }\\n ]\\n },\\n \\"ItemsNumbers\\": 1,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"RequestId\\": \\"33517002-182D-40BE-93EC-610BD3381045\\",\\n \\"TotalRecords\\": 100\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n\\t\\t\\r\\n\\t\\t\\tUnlock\\r\\n\\t\\t\\t1\\r\\n\\t\\t\\tEnable\\r\\n\\t\\t\\t2019-06-12T05:44:21Z\\r\\n\\t\\t\\tEnable\\r\\n\\t\\t\\t1\\r\\n\\t\\t\\trm-bpxxxxx\\r\\n\\t\\t\\t15\\r\\n\\t\\t\\t测试数据库\\r\\n\\t\\t\\tMySQL\\r\\n\\t\\t\\t2019-06-12T05:44:21Z\\r\\n\\t\\t\\tcn-shanghai\\r\\n\\t\\t\\t5.6\\r\\n\\t\\t\\tRunning\\r\\n\\t\\t\\r\\n\\t\\r\\n\\t1\\r\\n\\tcn-hangzhou\\r\\n\\t33517002-182D-40BE-93EC-610BD3381045\\r\\n\\t1\\r\\n\\t1\\r\\n","errorExample":""}]', 'title' => 'DescribeCrossRegionBackupDBInstance', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> Before you call this operation, read the following topics and make sure that you fully understand the prerequisites and impacts of this operation.'."\n" ."\n" .'* [Use the cross-region backup feature of an ApsaraDB RDS for MySQL instance](~~120824~~)'."\n" .'* [Use the cross-region backup feature for an ApsaraDB RDS for PostgreSQL instance](~~206671~~)'."\n" .'* [Use the cross-region backup feature for an ApsaraDB RDS for SQL Server instance](~~187923~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'CheckCreateDdrDBInstance' => [ 'summary' => 'Queries whether an instance can be restored by using a cross-region backup set.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the destination instance. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'Engine', 'in' => 'query', 'schema' => [ 'description' => 'The database engine of the destination instance. Valid values:'."\n" ."\n" .'* **MySQL**'."\n" .'* **SQLServer**'."\n" .'* **PostgreSQL**'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MySQL', ], ], [ 'name' => 'EngineVersion', 'in' => 'query', 'schema' => [ 'description' => 'The major engine version of the destination instance. The value of this parameter varies based on the value of **Engine**.'."\n" ."\n" .'* Valid values when Engine is set to MySQL: **5.5, 5.6, 5.7, and 8.0**'."\n" .'* Valid values when Engine is set to SQLServer: **2008r2, 08r2\\_ent_ha, 2012, 2012\\_ent_ha, 2012\\_std_ha, 2012\\_web, 2014\\_std_ha, 2016\\_ent_ha, 2016\\_std_ha, 2016\\_web, 2017\\_std_ha, 2017\\_ent, 2019\\_std_ha, and 2019\\_ent**'."\n" .'* PostgreSQL: **10.0, 11.0, 12.0, 13.0, 14.0, and 15.0**'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '5.6', ], ], [ 'name' => 'DBInstanceClass', 'in' => 'query', 'schema' => [ 'description' => 'The instance type of the destination instance. For more information, see [Primary ApsaraDB RDS instance types](~~26312~~).'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rds.mysql.s1.small', ], ], [ 'name' => 'DBInstanceStorage', 'in' => 'query', 'schema' => [ 'description' => 'The storage capacity of the destination instance. Valid values: **5 to 2000**. Unit: GB. You can increase the storage capacity in increments of 5 GB. For more information, see [Primary instance types](~~26312~~).'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '20', ], ], [ 'name' => 'RestoreType', 'in' => 'query', 'schema' => [ 'description' => 'The method that is used to restore data. Valid values:'."\n" ."\n" .'* **0**: restores data from a backup set. If you set this parameter to 0, you must also specify the **BackupSetId** parameter.'."\n" .'* **1**: restores data to a point in time. If you set this parameter to 1, you must also specify the **RestoreTime**, **SourceRegion**, and **SourceDBInstanceName** parameters.'."\n" ."\n" .'Default value: **0**.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0', ], ], [ 'name' => 'BackupSetId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the backup set that is used for the restoration. You can call the DescribeCrossRegionBackups operation to query the backup set ID.'."\n" ."\n" .'> This parameter must be specified when the **RestoreType** parameter is set to **0**.'."\n", 'type' => 'string', 'required' => false, 'example' => '14358', ], ], [ 'name' => 'RestoreTime', 'in' => 'query', 'schema' => [ 'description' => 'The point in time to which you want to restore data. The point in time that you specify must be earlier than the current time. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is displayed in UTC.'."\n" ."\n" .'> If you set **RestoreType** to **1**, you must also specify this parameter.', 'type' => 'string', 'required' => false, 'example' => '2019-05-30T03:29:10Z', ], ], [ 'name' => 'SourceRegion', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the source instance if you want to restore data to a point in time.'."\n" ."\n" .'> If you set **RestoreType** to **1**, you must also specify this parameter.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'SourceDBInstanceName', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the source instance if you want to restore data to a point in time.'."\n" ."\n" .'> This parameter must be specified when the **RestoreType** parameter is set to **1**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rm-uf6wjk5xxxxxxx', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The resource group ID. You can call the DescribeDBInstanceAttribute to query the resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'IsValid' => [ 'description' => 'Indicates whether the data of the source instance can be restored across regions. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'string', 'example' => 'true', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance engine and type does not support operations.', ], [ 'errorCode' => 'InvalidRestoreType.Format', 'errorMessage' => 'Specified restore type is not valid.', ], [ 'errorCode' => 'NoBackupSetRegion', 'errorMessage' => 'BackupSetRegion is absence.', ], [ 'errorCode' => 'IncorrectBackupSetType', 'errorMessage' => 'Backup set type should be ddr.', ], [ 'errorCode' => 'NoSourceInstanceName', 'errorMessage' => 'No SourceDBInstanceName.', ], [ 'errorCode' => 'NoAvailableDisasterRestoreBakset', 'errorMessage' => 'No available disaster restore bakset.', ], [ 'errorCode' => 'IncorrectBackupSetMethod', 'errorMessage' => 'Current backup set method does not support operations.', ], [ 'errorCode' => 'InvalidBackupType.Format', 'errorMessage' => 'Specified backup type is not valid.', ], [ 'errorCode' => 'IncorrectEngineVersion', 'errorMessage' => 'Current engine version does not support operations.', ], [ 'errorCode' => 'IncorrectBaksetVersion', 'errorMessage' => 'Current bakset version does not support operations.', ], [ 'errorCode' => 'CrossRegionUnsupportTDE', 'errorMessage' => 'Cross-region disaster restore not support TDE bakset.', ], [ 'errorCode' => 'DisasterRestoreRegionNotMatched', 'errorMessage' => 'Disaster restore should be operated in the ddr region or source region.', ], [ 'errorCode' => 'InvalidMinorVersion.NotFound', 'errorMessage' => 'Specified minor version does not exists.', ], [ 'errorCode' => 'InvalidDBInstanceId.MalFormed', 'errorMessage' => 'The specified parameter DBInstanceId is not valid.', ], [ 'errorCode' => 'InvalidEngine.Malformed', 'errorMessage' => 'Specified engine is not valid.', ], [ 'errorCode' => 'InvalidEngineVersion.Malformed', 'errorMessage' => 'Specified engine version is not valid.', ], [ 'errorCode' => 'MissingUserID', 'errorMessage' => 'The request is missing a user_id parameter.', ], [ 'errorCode' => 'MissingUID', 'errorMessage' => 'The request is missing a uid parameter.', ], [ 'errorCode' => 'UserPermissionFailure', 'errorMessage' => 'The request processing has failed due to user permission.', ], [ 'errorCode' => 'InvalidServiceType.Format', 'errorMessage' => 'Specified service type is not valid.', ], [ 'errorCode' => 'InvalidStorage.Format', 'errorMessage' => 'Specified Storage is not valid.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'IncorrectDBType', 'errorMessage' => 'The current DB type does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstance', 'errorMessage' => 'The current DB instance does not support this operation.', ], [ 'errorCode' => 'ResourceConfigError', 'errorMessage' => 'The request processing has failed due to resource config error.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'RestoreType.NotFound', 'errorMessage' => 'RestoreType is not found.', ], [ 'errorCode' => 'InvalidBackupSetID.NotFound', 'errorMessage' => 'Specified backup set ID does not exist.', ], [ 'errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance does not exist or is not supported.', ], [ 'errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'Specified DB instance class is not found.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"IsValid\\": \\"true\\",\\n \\"RequestId\\": \\"1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n true\\r\\n 346C62D7-8BB9-4516-93E7-25A469EAABCB\\r\\n","errorExample":""}]', 'title' => 'CheckCreateDdrDBInstance', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" ."\n" .'> If your ApsaraDB RDS for PostgreSQL instance uses the new architecture and is created after October 10, 2022, this feature is not supported for the RDS instance. For more information, see [\\[Notice\\] SLR authorization is required to create an ApsaraDB RDS for PostgreSQL instance from October 10, 2022](~~452313~~).'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.'."\n" ."\n" .'* [Use the cross-region backup feature of an ApsaraDB RDS for MySQL instance](~~120824~~) and [Restore the data of an ApsaraDB RDS for MySQL instance across regions](~~120875~~)'."\n" .'* [Use the cross-region backup feature of an ApsaraDB RDS for PostgreSQL instance](~~206671~~) and [Restore the data of an ApsaraDB RDS for PostgreSQL across regions](~~206662~~)'."\n" .'* [Use the cross-region backup feature of an ApsaraDB RDS for SQL Server instance](~~187923~~) and [Restore the data of an ApsaraDB RDS for SQL Server across regions](~~187924~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'RestoreDdrTable' => [ 'summary' => 'Restores data to an existing instance across regions.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The source instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-bpxxxxx', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the destination instance. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxxxxx', ], ], [ 'name' => 'RestoreType', 'in' => 'query', 'schema' => [ 'description' => 'The method that is used to restore data. Valid values:'."\n" ."\n" .'* **0**: restores data from a backup set. If you set this parameter to 0, you must also specify the **BackupSetId** parameter.'."\n" .'* **1**: restores data to a point in time. If you set this parameter to 1, you must also specify the **RestoreTime**, **SourceRegion**, and **SourceDBInstanceName** parameters.'."\n" ."\n" .'Default value: **0**.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0', ], ], [ 'name' => 'BackupId', 'in' => 'query', 'schema' => [ 'description' => 'The cross-region backup set ID. You can call the DescribeCrossRegionBackups operation to query the IDs of the backup sets that are available to an instance.'."\n" ."\n" .'> If you set the **RestoreType** parameter to **0**, you must also specify the BackupId parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => '279563', ], ], [ 'name' => 'RestoreTime', 'in' => 'query', 'schema' => [ 'description' => 'The point in time to which you want to restore data. The point in time that you specify must be earlier than the current time. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time must be in UTC.'."\n" ."\n" .'> If **RestoreType** is set to **BackupTime**, you must specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => '2020-04-25T16:00:00Z', ], ], [ 'name' => 'SourceRegion', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the source instance if you want to restore data to a point in time.'."\n" ."\n" .'> : If you set **RestoreType** to **1**, you must also specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', ], ], [ 'name' => 'SourceDBInstanceName', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the source instance whose data you want to restore to a point in time.'."\n" ."\n" .'> If you set the **RestoreType** parameter to **1**, you must also specify the SourceDBInstanceName parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rm-bpxxxxx', ], ], [ 'name' => 'TableMeta', 'in' => 'query', 'schema' => [ 'description' => 'The names of the databases and tables that you want to restore. The value is in the following format: `[{"type":"db","name":"","newname":"","tables":[{"type":"table","name":"","newname":""},{"type":"table","name":"","newname":""}]},{"type":"db","name":"","newname":"","tables":[{"type":"table","name":"","newname":""},{"type":"table","name":"","newname":""}]}]`'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '[{"type":"db","name":"testdb1","newname":"testdb1","tables":[{"type":"table","name":"test1","newname":"test1_backup"},{"type":"table","name":"test2","newname":"test2_backup"}]}]', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy*****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'DBInstanceId' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5*****', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '75BBF1EF-1E90-4950-BFFB-252D26E8259B', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidRestoreType.Format', 'errorMessage' => 'Specified restore type is not valid.', ], [ 'errorCode' => 'InvalidRestoreTime.Format', 'errorMessage' => 'Specified restore time is not valid.', ], [ 'errorCode' => 'InvalidBakset.Invalid', 'errorMessage' => 'Specified bakset is not valid.', ], [ 'errorCode' => 'InvalidParamTableMetaForRestore.Content', 'errorMessage' => 'new dbname or table in TableMeta cannot be same with old when restore to source instance', ], [ 'errorCode' => 'InvalidParamTableMeta', 'errorMessage' => 'Invalid parameter TableMeta is null or not json format', ], [ 'errorCode' => 'InvalidBakHistoryDO', 'errorMessage' => 'BakHistory is inbalid when check restore TableMeta', ], [ 'errorCode' => 'InvalidParamTableMeta.Content', 'errorMessage' => 'TableMeta missing old dbname or new dbname, please check', ], [ 'errorCode' => 'InvalidParamTableMeta.Duplicate', 'errorMessage' => 'TableMeta has duplicate db or table with other newname, commons or system', ], [ 'errorCode' => 'InvalidSourceRestoreDBName.NotFound', 'errorMessage' => 'specific source restore dbname is not found in db list', ], [ 'errorCode' => 'InvalidDBName.Duplicate', 'errorMessage' => 'Specified DB name already exists in the This instance.', ], [ 'errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'Specified parameters is not valid.', ], [ 'errorCode' => 'InvalidAvZone.Format', 'errorMessage' => 'Specified AvZone is not valid.', ], [ 'errorCode' => 'InvalidRegion.Format', 'errorMessage' => 'Specified Region is not valid.', ], [ 'errorCode' => 'InvalidVpcParameter', 'errorMessage' => 'Specified VPCId VSwitchId or IPAddress or TunnelId is not valid.', ], [ 'errorCode' => 'MissingUserID', 'errorMessage' => 'The request is missing a user_id parameter.', ], [ 'errorCode' => 'MissingUID', 'errorMessage' => 'The request is missing a uid parameter.', ], [ 'errorCode' => 'NoAvailableDisasterRestoreBakset', 'errorMessage' => 'No available disaster restore bakset.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', ], [ 'errorCode' => 'ChildDBInstanceExists', 'errorMessage' => 'Current DB instance had child instance.', ], [ 'errorCode' => 'InvalidBackupLogStatus', 'errorMessage' => 'Current backup log enable status does not support this operation.', ], [ 'errorCode' => 'IncorrectBackupSetMethod', 'errorMessage' => 'Current backup set method does not support operations.', ], [ 'errorCode' => 'IncorrectBackupSetState', 'errorMessage' => 'Current backup set state does not support operations.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'RestoreType.NotFound', 'errorMessage' => 'RestoreType is not found.', ], [ 'errorCode' => 'InvalidBackupSetID.NotFound', 'errorMessage' => 'Specified backup set ID does not exist.', ], [ 'errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is insufficient capacity available for the requested instance.', ], [ 'errorCode' => 'InvalidBackup.NotFound', 'errorMessage' => 'The available backup does not exist in recovery time.', ], [ 'errorCode' => 'InvalidBinlog.NotFound', 'errorMessage' => 'The available binlog does not exist in recovery time.', ], [ 'errorCode' => 'InvalidDB.NotFound', 'errorMessage' => 'Specified db does not exist or DB status does not support.', ], [ 'errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'Specified instance does not exist or not support.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBInstanceId\\": \\"rm-uf6wjk5****\\",\\n \\"RequestId\\": \\"75BBF1EF-1E90-4950-BFFB-252D26E8259B\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n75BBF1EF-1E90-4950-BFFB-252D26E8259B\\r\\n","errorExample":""}]', 'title' => 'RestoreDdrTable', 'description' => '> Before restoration, you can call the CheckCreateDdrDBInstance operation to check whether a cross-region backup set can be used for cross-region restoration.'."\n" ."\n" .'### [](#)Supported database engines'."\n" ."\n" .'MySQL'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> Before you call this operation, read the following topics and make sure that you fully understand the prerequisites and impacts of this operation.'."\n" ."\n" .'* [Use the cross-region backup feature for an ApsaraDB RDS for MySQL instance](~~120824~~)'."\n" .'* [Restore the data of an ApsaraDB RDS for MySQL instance across regions](~~120875~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ModifyDBInstanceMonitor' => [ 'summary' => 'Modifies a monitoring frequency.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxx', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5xxxxxxx', ], ], [ 'name' => 'Period', 'in' => 'query', 'schema' => [ 'description' => 'The monitoring frequency that you want to use. Valid values:'."\n" ."\n" .'* **5**'."\n" .'* **10**'."\n" .'* **60**'."\n" .'* **300**'."\n" ."\n" .'Unit: seconds.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '60', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '52B9805C-432C-4ED1-83FD-2F916B6D2733', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidParameter.OwnerAccount', 'errorMessage' => 'The specified parameter OwnerAccount is not valid.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OperationDenied.DBInstanceMonitorPeriod', 'errorMessage' => 'Current DB instance does not support this monitor period.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"52B9805C-432C-4ED1-83FD-2F916B6D2733\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"7463B73D-35CC-4D19-A010-6B8D65D242EF\\",\\n \\"HostId\\": \\"rds.aliyuncs.com\\",\\n \\"Code\\": \\"UnsupportedOperation\\",\\n \\"Message\\": \\"The specified action is not supported.\\"\\n}"},{"type":"xml","example":"\\n\\n\\t52B9805C-432C-4ED1-83FD-2F916B6D2733\\n\\n\\t\\n","errorExample":""}]', 'title' => 'ModifyDBInstanceMonitor', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* SQL Server'."\n" ."\n" .'### [](#)Usage notes'."\n" ."\n" .'If you use the Every 5 Seconds monitoring frequency, you are charged additional fees. Before you call this operation, make sure that you understand the [billing methods and pricing](~~45020~~) of ApsaraDB RDS.'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.'."\n" ."\n" .'* [Configure the monitoring frequency for an ApsaraDB RDS for MySQL instance](~~96112~~)'."\n" .'* [Configure the monitoring frequency for an ApsaraDB RDS for SQL Server instance](~~95710~~)', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ModifyDBInstanceMetrics' => [ 'summary' => 'Modifies the Enhanced Monitoring metrics that are displayed for an ApsaraDB RDS for PostgreSQL instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pgm-bp1s1j103lo6****', ], ], [ 'name' => 'Scope', 'in' => 'query', 'schema' => [ 'description' => 'The application scope of this modification. Valid values:'."\n" ."\n" .'* **instance**: This modification is applied only to the current instance.'."\n" .'* **region**: This modification is applied to all ApsaraDB RDS for PostgreSQL instances that are equipped with the same type of storage media as the current instance in the region to which the current instance belongs. For example, if the current instance is equipped with cloud disks, this modification is applied to all ApsaraDB RDS for PostgreSQL instances that are equipped with cloud disks in the region to which the current instance belongs.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'instance', ], ], [ 'name' => 'MetricsConfig', 'in' => 'query', 'schema' => [ 'description' => 'The keys of the Enhanced Monitoring metrics that you want to display for the instance. You can enter a maximum of 30 metric keys. If you enter multiple metric keys, you must separate the metric keys with commas (,).'."\n" ."\n" .'You can call the DescribeAvailableMetrics operation to query the keys of metrics.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'os.cpu_usage.sys.avg,os.cpu_usage.user.avg', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'DBInstanceId' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'pgm-bp1s1j103lo6****', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'B55934BB-FFAA-5276-80A8-E0FDB12810B3', ], 'Scope' => [ 'description' => 'The application scope of this modification. Valid values:'."\n" ."\n" .'* **instance**: This modification is applied only to the current instance.'."\n" .'* **region**: This modification is applied to all ApsaraDB RDS for PostgreSQL instances that are equipped with the same type of storage media as the current instance in the region to which the current instance belongs.'."\n", 'type' => 'string', 'example' => 'instance', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidMetricsConfig', 'errorMessage' => 'The specified metrics config is invalid.', ], [ 'errorCode' => 'InvalidScope', 'errorMessage' => 'The specified scope is invalid', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBInstanceId\\": \\"pgm-bp1s1j103lo6****\\",\\n \\"RequestId\\": \\"B55934BB-FFAA-5276-80A8-E0FDB12810B3\\",\\n \\"Scope\\": \\"instance\\"\\n}","errorExample":""},{"type":"xml","example":"\\n\\n B55934BB-FFAA-5276-80A8-E0FDB12810B3\\n instance\\n pgm-bp1s1j103lo6****\\n\\n","errorExample":""}]', 'title' => 'ModifyDBInstanceMetrics', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* PostgreSQL'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.'."\n" ."\n" .'[View the Enhanced Monitoring metrics](~~299200~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeResourceUsage' => [ 'summary' => 'Queries the storage usage of an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5xxxxxxx', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy*****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'ArchiveBackupSize' => [ 'description' => 'The storage that is occupied by archived backup files on the instance. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'BackupDataSize' => [ 'description' => 'The storage that is occupied by data backup files, excluding archived backup files, on the instance. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '94324736', ], 'BackupLogSize' => [ 'description' => 'The storage that is occupied by log backup files, excluding archived backup files, on the instance. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '45145563', ], 'BackupOssDataSize' => [ 'description' => 'The size of data backup files that are stored in Object Storage Service (OSS) buckets. Unit: bytes. The value 0 indicates no data backup files are stored in OSS buckets.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '8821760', ], 'BackupOssLogSize' => [ 'description' => 'The size of log backup files that are stored in OSS buckets. Unit: bytes. The value 0 indicates no log backup files are stored in OSS buckets.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '44180999', ], 'BackupSize' => [ 'description' => 'The storage that is used to store backup files. Unit: bytes. The value -1 indicates that no backup files are stored.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '53002759', ], 'ColdBackupSize' => [ 'description' => 'The storage that is used to store cold backup files. Unit: bytes. The value -1 indicates that no cold backup files are stored.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2337275904', ], 'DBInstanceId' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => ' rm-uf6wjk5xxxxxxx', ], 'DataSize' => [ 'description' => 'The storage that is used to store data files. Unit: bytes. The value -1 indicates that no data files are stored.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1292094741', ], 'DiskUsed' => [ 'description' => 'The total storage that is occupied by data files and log files on the instance. Unit: bytes. The value -1 indicates that no data files or log files are stored on the instance.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2337275904', ], 'Engine' => [ 'description' => 'The database engine of the instance.'."\n", 'type' => 'string', 'example' => 'MySQL', ], 'LogSize' => [ 'description' => 'The storage that is used to store log files. Unit: bytes. The value -1 indicates that no log files are stored.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1045181163', ], 'PaidBackupSize' => [ 'description' => 'The backup storage for which you must pay. The system provides a free quota on backup storage. You must pay for the backup storage that exceeds the free quota. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'F937E173-559C-4498-8D90-38D32342B9E4', ], 'SQLSize' => [ 'description' => 'The storage that is occupied to execute SQL statements on the instance. Unit: bytes. The value -1 indicates that no SQL statements are executed.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '315052751', ], 'BackupEcsSnapshotSize' => [ 'description' => 'The storage capacity that is used to store the snapshot backup files of the **RDS for SQL Server** instance. Unit: bytes. The value 0 indicates that no snapshot backup files are stored for the instance.', 'type' => 'string', 'example' => '0', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"ArchiveBackupSize\\": 0,\\n \\"BackupDataSize\\": 94324736,\\n \\"BackupLogSize\\": 45145563,\\n \\"BackupOssDataSize\\": 8821760,\\n \\"BackupOssLogSize\\": 44180999,\\n \\"BackupSize\\": 53002759,\\n \\"ColdBackupSize\\": 2337275904,\\n \\"DBInstanceId\\": \\" rm-uf6wjk5******\\",\\n \\"DataSize\\": 1292094741,\\n \\"DiskUsed\\": 2337275904,\\n \\"Engine\\": \\"MySQL\\",\\n \\"LogSize\\": 1045181163,\\n \\"PaidBackupSize\\": 0,\\n \\"RequestId\\": \\"F937E173-559C-4498-8D90-38D32342B9E4\\",\\n \\"SQLSize\\": 315052751,\\n \\"BackupEcsSnapshotSize\\": \\"0\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"7463B73D-35CC-4D19-A010-6B8D65D242EF\\",\\n \\"HostId\\": \\"rds.aliyuncs.com\\",\\n \\"Code\\": \\"UnsupportedOperation\\",\\n \\"Message\\": \\"The specified action is not supported.\\"\\n}"},{"type":"xml","example":"\\n0\\n28E73580-103C-4925-A48D-9A7E25F24297\\n51305057407\\n0\\n-1\\n2097152\\n48565375\\n rm-uf6wjk5xxxxxxx\\n51256492032\\n3198156800\\n48565375\\n0\\n446228522\\n3200253952\\nMySQL\\n","errorExample":""}]', 'title' => 'DescribeResourceUsage', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" .'* MariaDB'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeDBInstancePerformance' => [ 'summary' => 'Queries the performance metrics of an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => ' rm-uf6wjk5xxxxxxx', ], ], [ 'name' => 'Key', 'in' => 'query', 'schema' => [ 'description' => 'The performance metrics that you want to query. Separate multiple values with commas (,). You can specify up to 30 values. For more information, see [Performance parameters](~~26316~~).'."\n" ."\n" .'> If you set **Key** to **MySQL_SpaceUsage** or **SQLServer_SpaceUsage**, you can query the monitoring data within only one day.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MySQL_Sessions', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in UTC.'."\n" ."\n" .'> The time span between the beginning time and the end time must be longer than the monitoring frequency. Otherwise, this operation may return an empty array.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2012-06-08T15:00Z', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => 'The end of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in UTC.'."\n" ."\n" .'> The time span between the beginning time and the end time must be longer than the monitoring frequency. Otherwise, this operation may return an empty array.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2012-06-18T15:00Z', ], ], [ 'name' => 'NodeId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => '339****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'DBInstanceId' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5xxxxxxxxxx', ], 'EndTime' => [ 'description' => 'The end time of the query. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in UTC.'."\n", 'type' => 'string', 'example' => '2012-06-19T15:00Z', ], 'Engine' => [ 'description' => 'The database engine of the instance.'."\n", 'type' => 'string', 'example' => 'MySQL', ], 'PerformanceKeys' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'PerformanceKey' => [ 'description' => 'Details of the performance metrics.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Key' => [ 'description' => 'The name of the performance metric.'."\n", 'type' => 'string', 'example' => 'MySQL_Sessions', ], 'Unit' => [ 'description' => 'The unit of the performance metrics.'."\n", 'type' => 'string', 'example' => 'KB', ], 'ValueFormat' => [ 'description' => 'The format in which the value of the performance metric is returned.'."\n" ."\n" .'> If a performance metric value consists of multiple fields, the values are separated with ampersands (&). Example: com_delete\\&com_insert\\&com_insert_select\\&com_replace.'."\n", 'type' => 'string', 'example' => 'recv_k&sent_k', ], 'Values' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'PerformanceValue' => [ 'description' => 'The performance metric values.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Date' => [ 'description' => 'The date and time when the value of the performance metric was recorded. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2011-05-30T03:29:00Z', ], 'Value' => [ 'description' => 'The value of the performance metric.'."\n", 'type' => 'string', 'example' => '0.0&13.6', ], ], ], ], ], ], ], ], ], ], ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'A5409D02-D661-4BF3-8F3D-0A814D0574E7', ], 'StartTime' => [ 'description' => 'The start time of the query. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in UTC.'."\n", 'type' => 'string', 'example' => '2012-06-10T15:00Z', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 408 => [ [ 'errorCode' => 'InvalidOthers.Timeout', 'errorMessage' => 'Query timed out.Please try again or narrow down the query scope.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBInstanceId\\": \\"rm-uf6wjk5****\\",\\n \\"EndTime\\": \\"2012-06-19T15:00Z\\",\\n \\"Engine\\": \\"MySQL\\",\\n \\"PerformanceKeys\\": {\\n \\"PerformanceKey\\": [\\n {\\n \\"Key\\": \\"MySQL_NetworkTraffic\\",\\n \\"Unit\\": \\"KB\\",\\n \\"ValueFormat\\": \\"recv_k&sent_k\\",\\n \\"Values\\": {\\n \\"PerformanceValue\\": [\\n {\\n \\"Date\\": \\"2011-05-30T03:29:00Z\\",\\n \\"Value\\": \\"5.35&6.74\\"\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"RequestId\\": \\"A5409D02-D661-4BF3-8F3D-0A814D0574E7\\",\\n \\"StartTime\\": \\"2012-06-10T15:00Z\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"7463B73D-35CC-4D19-A010-6B8D65D242EF\\",\\n \\"HostId\\": \\"rds.aliyuncs.com\\",\\n \\"Code\\": \\"UnsupportedOperation\\",\\n \\"Message\\": \\"The specified action is not supported.\\"\\n}"},{"type":"xml","example":"\\n\\n\\tA5409D02-D661-4BF3-8F3D-0A814D0574E7\\n\\t rm-uf6wjk5xxxxxxx\\n\\t2012-06-11T15:00Z\\n\\t2013-10-17T15:00Z\\n\\tMySQL\\n\\t\\n\\t\\t\\n\\t\\t\\tMySQL_NetworkTraffic\\n\\t\\t\\tKB\\n\\t\\t\\trecv_k&sent_k\\n\\t\\t\\t\\n\\t\\t\\n\\t\\n\\n\\t\\n","errorExample":""}]', 'title' => 'DescribeDBInstancePerformance', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" .'* MariaDB'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeDBInstanceMonitor' => [ 'summary' => 'Queries the monitoring frequency of an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxx', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5xxxxxxx', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Period' => [ 'description' => 'The monitoring frequency. Unit: seconds.'."\n", 'type' => 'string', 'example' => '60', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '30829FD4-1A84-4C2A-A625-2EADECB95CA3', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidParameter.OwnerAccount', 'errorMessage' => 'The specified parameter OwnerAccount is not valid.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Period\\": \\"60\\",\\n \\"RequestId\\": \\"30829FD4-1A84-4C2A-A625-2EADECB95CA3\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"7463B73D-35CC-4D19-A010-6B8D65D242EF\\",\\n \\"HostId\\": \\"rds.aliyuncs.com\\",\\n \\"Code\\": \\"UnsupportedOperation\\",\\n \\"Message\\": \\"The specified action is not supported.\\"\\n}"},{"type":"xml","example":"\\n\\n\\t60\\n\\t30829FD4-1A84-4C2A-A625-2EADECB95CA3\\n\\n\\t\\n","errorExample":""}]', 'title' => 'DescribeDBInstanceMonitor', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* SQL Server'."\n" .'* MariaDB'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeAvailableMetrics' => [ 'summary' => 'Queries all Enhanced Monitoring metrics that are supported by an ApsaraDB RDS for PostgreSQL instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pgm-bp1s1j103lo6****', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy*****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'DBInstanceName' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-bp1*****', ], 'Items' => [ 'description' => 'Details of the Enhanced Monitoring metric.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Description' => [ 'description' => 'The description of the Enhanced Monitoring metric.'."\n", 'type' => 'string', 'example' => 'OS CPU utilization, equal to the number of OS-consumed CPUs divided by the total number of CPUs'."\n", ], 'Dimension' => [ 'description' => 'The category of the Enhanced Monitoring metric. Valid values:'."\n" ."\n" .'* **os**: OS metric'."\n" .'* **db**: database metric'."\n", 'type' => 'string', 'example' => 'os', ], 'GroupKey' => [ 'description' => 'The key of the group to which the Enhanced Monitoring metric belongs.'."\n", 'type' => 'string', 'example' => 'os.cpu_usage', ], 'GroupKeyType' => [ 'description' => 'The name of the group to which the Enhanced Monitoring metric belongs.'."\n", 'type' => 'string', 'example' => 'CPU Utilization Rate'."\n", ], 'Method' => [ 'description' => 'The method that is used to aggregate the monitoring data of the Enhanced Monitoring metric. Valid values:'."\n" ."\n" .'* **avg**: The system calculates the average value of the Enhanced Monitoring metric.'."\n" .'* **min**: The system calculates the minimum value of the Enhanced Monitoring metric.'."\n" .'* **max**: The system calculates the maximum value of the Enhanced Monitoring metric.'."\n", 'type' => 'string', 'example' => 'avg', ], 'MetricsKey' => [ 'description' => 'The key of the Enhanced Monitoring metric.'."\n", 'type' => 'string', 'example' => 'os.cpu_usage.sys.avg', ], 'MetricsKeyAlias' => [ 'description' => 'The alias of the Enhanced Monitoring metric.'."\n", 'type' => 'string', 'example' => 'cpu_sys_per_core', ], 'SortRule' => [ 'description' => 'The serial number of the Enhanced Monitoring metric.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Unit' => [ 'description' => 'The unit of the Enhanced Monitoring metric.'."\n", 'type' => 'string', 'example' => '%', ], ], ], ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '5CD61041-35F7-10F7-BE94-33A48B221218', ], 'TotalRecordCount' => [ 'description' => 'The total number of enhanced monitoring metrics that are available for the instance.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '4', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBInstanceName\\": \\"rm-bp1****\\",\\n \\"Items\\": [\\n {\\n \\"Description\\": \\"sys cpu使用率，sys cpu使用量 / cpu总量\\",\\n \\"Dimension\\": \\"os\\",\\n \\"GroupKey\\": \\"os.cpu_usage\\",\\n \\"GroupKeyType\\": \\"CPU使用率\\",\\n \\"Method\\": \\"avg\\",\\n \\"MetricsKey\\": \\"os.cpu_usage.sys.avg\\",\\n \\"MetricsKeyAlias\\": \\"cpu_sys_per_core\\",\\n \\"SortRule\\": 1,\\n \\"Unit\\": \\"%\\"\\n }\\n ],\\n \\"RequestId\\": \\"5CD61041-35F7-10F7-BE94-33A48B221218\\",\\n \\"TotalRecordCount\\": 4\\n}","errorExample":""},{"type":"xml","example":"\\n2\\nA467D279-68A8-57B3-BDA4-35F8B3DDB1B7\\n\\n sys cpu使用率，sys cpu使用量 / cpu总量\\n os.cpu_usage.sys.avg\\n CPU使用率\\n os.cpu_usage\\n avg\\n os\\n %\\n 1\\n pgsql\\n os.cpu_usage.sys\\n\\n\\n user cpu使用率，user cpu使用量 / cpu总量\\n os.cpu_usage.user.avg\\n CPU使用率\\n os.cpu_usage\\n avg\\n os\\n %\\n 2\\n pgsql\\n os.cpu_usage.user\\n\\n","errorExample":""}]', 'title' => 'DescribeAvailableMetrics', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* PostgreSQL'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.'."\n" ."\n" .'[View the Enhanced Monitoring metrics](~~299200~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeDBInstanceMetrics' => [ 'summary' => 'Queries the Enhanced Monitoring metrics that are displayed for an ApsaraDB RDS for PostgreSQL instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pgm-bp1s1j103lo6****', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy*****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'DBInstanceName' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-bp1*****', ], 'Items' => [ 'description' => 'An array consisting of the Enhanced Monitoring metrics that are enabled for the instance.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Description' => [ 'description' => 'The description of the enhanced monitoring metric.'."\n", 'type' => 'string', 'example' => 'OS CPU utilization, equal to the number of OS-consumed CPUs divided by the total number of CPUs'."\n", ], 'Dimension' => [ 'description' => 'The category of the enhanced monitoring metric. Valid values:'."\n" ."\n" .'* **os**: OS metric'."\n" .'* **db**: database metric'."\n", 'type' => 'string', 'example' => 'os', ], 'GroupKey' => [ 'description' => 'The key of the group to which the enhanced monitoring metric belongs.'."\n", 'type' => 'string', 'example' => 'os.cpu_usage', ], 'GroupKeyType' => [ 'description' => 'The name of the group to which the enhanced monitoring metric belongs.'."\n", 'type' => 'string', 'example' => 'CPU Utilization Rate'."\n", ], 'Method' => [ 'description' => 'The method that is used to aggregate the monitoring data of the enhanced monitoring metric. Valid values:'."\n" ."\n" .'* **avg**: The system calculates the average value of the enhanced monitoring metric.'."\n" .'* **min**: The system calculates the minimum value of the enhanced monitoring metric.'."\n" .'* **max**: The system calculates the maximum value of the enhanced monitoring metric.'."\n", 'type' => 'string', 'example' => 'avg', ], 'MetricsKey' => [ 'description' => 'The key of the enhanced monitoring metric.'."\n", 'type' => 'string', 'example' => 'os.cpu_usage.sys.avg', ], 'MetricsKeyAlias' => [ 'description' => 'The alias of the enhanced monitoring metric.'."\n", 'type' => 'string', 'example' => 'os.cpu_usage.sys', ], 'SortRule' => [ 'description' => 'The serial number of the enhanced monitoring metric.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Unit' => [ 'description' => 'The unit of the enhanced monitoring metric.'."\n", 'type' => 'string', 'example' => '%', ], ], ], ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '318C3754-F6D0-54BB-A55C-23EAA04708B7', ], 'TotalRecordCount' => [ 'description' => 'The total number of enhanced monitoring metrics that are enabled for the instance.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidInstanceMetricsConfigs.NotFound', 'errorMessage' => 'The specified instance has no metrics configs', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBInstanceName\\": \\"rm-bp1****\\",\\n \\"Items\\": [\\n {\\n \\"Description\\": \\"sys cpu使用率，sys cpu使用量 / cpu总量\\",\\n \\"Dimension\\": \\"os\\",\\n \\"GroupKey\\": \\"os.cpu_usage\\",\\n \\"GroupKeyType\\": \\"CPU使用率\\",\\n \\"Method\\": \\"avg\\",\\n \\"MetricsKey\\": \\"os.cpu_usage.sys.avg\\",\\n \\"MetricsKeyAlias\\": \\"os.cpu_usage.sys\\",\\n \\"SortRule\\": 1,\\n \\"Unit\\": \\"%\\"\\n }\\n ],\\n \\"RequestId\\": \\"318C3754-F6D0-54BB-A55C-23EAA04708B7\\",\\n \\"TotalRecordCount\\": 1\\n}","errorExample":""},{"type":"xml","example":"\\n1\\n318C3754-F6D0-54BB-A55C-23EAA04708B7\\n \\n sys cpu使用率，sys cpu使用量 / cpu总量\\n CPU使用率\\n os.cpu_usage.sys.avg\\n os.cpu_usage\\n os\\n avg\\n %\\n 1\\n os.cpu_usage.sys\\n \\n","errorExample":""}]', 'title' => 'DescribeDBInstanceMetrics', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* PostgreSQL'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.'."\n" ."\n" .'[View the Enhanced Monitoring metrics](~~299200~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'CreateParameterGroup' => [ 'summary' => 'Creates a parameter template for an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'create', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the parameter template. You can call the DescribeRegions operation to query the most recent zone list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'ParameterGroupName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the parameter template.'."\n" ."\n" .'* The value must start with a letter and can contain letters, digits, periods (.), and underscores (\\_).'."\n" .'* The value can be 8 to 64 characters in length.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test1234', ], ], [ 'name' => 'Engine', 'in' => 'query', 'schema' => [ 'description' => 'The database engine. Valid values:'."\n" ."\n" .'* **mysql**'."\n" .'* **PostgreSQL**'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'mysql', ], ], [ 'name' => 'EngineVersion', 'in' => 'query', 'schema' => [ 'description' => 'The database engine version of the instance.'."\n" ."\n" .'* If the instance runs MySQL, the instance must run one of the following MySQL versions:'."\n" ."\n" .' * **5.6**'."\n" .' * **5.7**'."\n" .' * **8.0**'."\n" ."\n" .'* If the instance runs PostgreSQL, the instance must run one of the following PostgreSQL versions:'."\n" ."\n" .' * **10.0**'."\n" .' * **11.0**'."\n" .' * **12.0**'."\n" .' * **13.0**'."\n" .' * **14.0**'."\n" .' * **15.0**'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '5.7', ], ], [ 'name' => 'Parameters', 'in' => 'query', 'schema' => [ 'description' => 'A JSON string that consists of parameters and their values in the parameter template. Format: {"Parameter 1":"Value of Parameter 1","Parameter 2":"Value of Parameter 2"...}. For more information about the parameters that can be modified, see [Modify the parameters of an ApsaraDB RDS for MySQL instance](~~96063~~) or [Modify the parameters of an ApsaraDB RDS for PostgreSQL instance](~~96751~~).'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"back_log":"3000","wait_timeout":"86400"}', ], ], [ 'name' => 'ParameterGroupDesc', 'in' => 'query', 'schema' => [ 'description' => 'The description of the parameter template. The value can be up to 200 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The resource group ID. You can call the DescribeDBInstanceAttribute operation to obtain the resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy*****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'ParameterGroupId' => [ 'description' => 'The ID of the parameter template. You can call the [DescribeParameterGroups](~~144491~~) operation to query the IDs of parameter templates.'."\n", 'type' => 'string', 'example' => 'rpg-q488w14xvsk****', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '7A41C147-C8D0-4DAE-A1A2-17EBCD60DFA1', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidParameters.Malformed', 'errorMessage' => 'The specified parameter "Parameters" is not valid.', ], [ 'errorCode' => 'ParamGroupsNameInvalid', 'errorMessage' => 'The specified parameter group name is invalid.', ], [ 'errorCode' => 'InvalidEngine.Malformed', 'errorMessage' => 'Specified engine is not valid.', ], [ 'errorCode' => 'InvalidEngineVersion.Malformed', 'errorMessage' => 'Specified engine version is not valid.', ], [ 'errorCode' => 'ParamGroupsDbTypeNotSupport', 'errorMessage' => 'The parameter group does not support the specified database type.', ], [ 'errorCode' => 'ParamGroupsDbVersionNotSupport', 'errorMessage' => 'The parameter group does not support the database version.', ], [ 'errorCode' => 'ParamNotExist', 'errorMessage' => 'This param Not Exist', ], [ 'errorCode' => 'ParamTypeError', 'errorMessage' => 'The parameter type error.', ], [ 'errorCode' => 'ParamGroupsNotExistOrTypeNotSupport', 'errorMessage' => 'The parameter group does not exist or its type is not supported.', ], [ 'errorCode' => 'InvalidRegion.Format', 'errorMessage' => 'Specified Region is not valid.', ], [ 'errorCode' => '%s', 'errorMessage' => 'The following parameters are prohibited:
%s', ], [ 'errorCode' => 'ParamGroupsDescInvalid', 'errorMessage' => 'The maximum length of parameter group description is exceeded.', ], [ 'errorCode' => 'InvalidParameterValue.NotStandard', 'errorMessage' => 'Invalid parameter format.', ], [ 'errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'Specified parameter is not valid', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"ParameterGroupId\\": \\"rpg-q488w14xvsk****\\",\\n \\"RequestId\\": \\"7A41C147-C8D0-4DAE-A1A2-17EBCD60DFA1\\"\\n}","errorExample":""},{"type":"xml","example":"\\n rpg-q488w14xvsk****\\n 7A41C147-C8D0-4DAE-A1A2-17EBCD60DFA1\\n","errorExample":""}]', 'title' => 'CreateParameterGroup', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.'."\n" ."\n" .'* [Use a parameter template to configure the parameters of ApsaraDB RDS for MySQL instances](~~130565~~)'."\n" .'* [Use a parameter template to configure the parameters of ApsaraDB RDS for PostgreSQL instances](~~457176~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DeleteParameterGroup' => [ 'summary' => 'Deletes a parameter template from an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'delete', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'ParameterGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The parameter template ID. You can call the DescribeParameterGroups operation to query the parameter template ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rpg-gfs****', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The resource group ID. You can call the DescribeDBInstanceAttribute to obtain the resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy*****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'ParameterGroupId' => [ 'description' => 'The ID of the parameter template.'."\n", 'type' => 'string', 'example' => 'rpg-gfs****', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '8AF26036-B254-4212-B8E4-EFBE818B7FD6', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'ParamGroupsNotExist', 'errorMessage' => 'The specified paramGroups does not exist.', ], [ 'errorCode' => 'ParamGroupsNotExistOrTypeNotSupport', 'errorMessage' => 'The parameter group does not exist or its type is not supported.', ], [ 'errorCode' => 'ParamGroupsInUse', 'errorMessage' => 'Delete an in-use param group is forbidden.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"ParameterGroupId\\": \\"rpg-gfs****\\",\\n \\"RequestId\\": \\"8AF26036-B254-4212-B8E4-EFBE818B7FD6\\"\\n}","errorExample":""},{"type":"xml","example":"\\n rpg-gfs****\\n 8AF26036-B254-4212-B8E4-EFBE818B7FD6\\n","errorExample":""}]', 'title' => 'DeleteParameterGroup', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.'."\n" ."\n" .'* [Use a parameter template to configure the parameters of ApsaraDB RDS for MySQL instances](~~130565~~)'."\n" .'* [Use a parameter template to configure the parameters of ApsaraDB RDS for PostgreSQL instances](~~457176~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ModifyParameter' => [ 'summary' => 'Modifies the parameter values of an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxxxxx', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5xxxxxxx', ], ], [ 'name' => 'Parameters', 'in' => 'query', 'schema' => [ 'description' => 'The JSON strings of parameters and their values. All the parameter values are of the string type. Format: {"Parameter name 1":"Parameter value 1","Parameter name 2":"Parameter value 2"...}. You can call the DescribeParameterTemplates operation to query parameter names and values.'."\n" ."\n" .'> If you specify this parameter, you do not need to specify **ParameterGroupId**.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '{"delayed_insert_timeout":"600","max_length_for_sort_data":"2048"}', ], ], [ 'name' => 'Forcerestart', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to restart the instance for a new parameter value to take effect. Valid values:'."\n" ."\n" .'* **true**: The system forcefully restarts the instance. If a new parameter value takes effect only after the instance restarts, you must set this parameter to true. Otherwise, the new parameter value cannot take effect.'."\n" .'* **false**: The system does not forcefully restart the instance.'."\n" ."\n" .'Default value: **false**.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'ParameterGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The parameter template ID.'."\n" ."\n" .'> * If you specify this parameter, you do not need to specify **Parameters**.'."\n" .'> * If the parameter template can be applied only after the instance is restarted, you must specify **Forcerestart**.', 'type' => 'string', 'required' => false, 'example' => 'rpg-xxxxxxxxx', ], ], [ 'name' => 'SwitchTimeMode', 'in' => 'query', 'schema' => [ 'description' => 'The time at which the modification takes effect. Valid values:'."\n" ."\n" .'- **Immediate**: immediately modifies the parameter. This is the default value.'."\n" .'- **MaintainTime**: modifies the parameter during the maintenance window of the instance. You can call the ModifyDBInstanceMaintainTime operation to change the maintenance window.'."\n" .'- **ScheduleTime**: modifies the parameter at the point in time that you specify. If you specify this value, you must also specify **SwitchTime**.', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'ScheduleTime' => 'modifies the parameter at the point in time that you specify. If you specify this value, you must also specify SwitchTime', 'Immediate' => 'immediately modifies the parameter', 'MaintainTime' => 'modifies the parameter during the maintenance window of the instance. You can call the ModifyDBInstanceMaintainTime operation to change the maintenance window', ], 'example' => 'ScheduleTime', ], ], [ 'name' => 'SwitchTime', 'in' => 'query', 'schema' => [ 'description' => 'The time at which the modification takes effect. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time must be in UTC.'."\n" ."\n" .'> This time must be later than the time at which you call this operation.'."\n", 'type' => 'string', 'required' => false, 'example' => '2022-05-06T09:24:00Z', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '542BB8D6-4268-45CC-A557-B03EFD7AB30A', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'PendingActionOverdue', 'errorMessage' => 'the action execution time is already overdue', ], [ 'errorCode' => 'EngineMigration.ActionDisabled', 'errorMessage' => 'Specified action is disabled while custins is in engine migration.', ], [ 'errorCode' => '%s', 'errorMessage' => 'The following parameters are prohibited:
%s', ], [ 'errorCode' => 'Invalid.ParamGroupDBCategory', 'errorMessage' => 'ParamGroup category is basic, not standard.', ], [ 'errorCode' => 'InvalidEffectiveTime.SpecialTimeIsNull', 'errorMessage' => 'SpecialTime is not valid.', ], [ 'errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'Specified parameters is not valid.', ], [ 'errorCode' => 'StorageEngine.NotSupported', 'errorMessage' => 'Current instance storage engine dose not support this operation.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'SystemParamGroupCode.Format', 'errorMessage' => 'Specific DBParamGroupId is not valid.', ], [ 'errorCode' => 'Database.ConnectError', 'errorMessage' => 'Database connect error. please check instance status and database processlist', ], [ 'errorCode' => 'InvalidInstanceParameter', 'errorMessage' => 'Specified name for the instance parameter is not valid.', ], [ 'errorCode' => 'GroupReplicationNotSupport.InvalidParameters', 'errorMessage' => 'Group Replication limits parameters and does not support modification.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'OperationDenied.XengineSwitch', 'errorMessage' => 'Current custins can not turn off xengine param.', ], [ 'errorCode' => 'InvalidParameterValue.Limit', 'errorMessage' => 'Parameter value exceeds limit.', ], ], 403 => [ [ 'errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'The current database instance type does not support the operation.', ], [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'The current database status does not support the operation.', ], [ 'errorCode' => 'ParamNotSupportedForCurrentVersion', 'errorMessage' => 'Parameter is not supported for current version.', ], [ 'errorCode' => 'Invalid.Parameter', 'errorMessage' => 'Specified parameters is not valid.', ], [ 'errorCode' => 'IncorrectEffectiveTime', 'errorMessage' => 'The specified EffectiveTime params is not valid.', ], [ 'errorCode' => 'GroupReplicationNotSupport.InvalidEngineVersion', 'errorMessage' => 'Group Replication requires the instance engine version to be 8.0.', ], [ 'errorCode' => 'GroupReplicationNotSupport.InvalidNodeClassCode', 'errorMessage' => 'Group Replication requires the ClassCode of each node to be consistent.', ], [ 'errorCode' => 'GroupReplicationNotSupport.InvalidNodeNum', 'errorMessage' => 'Group Replication is not supported, the number of nodes must be an odd number greater than or equal to 3.', ], [ 'errorCode' => 'GroupReplicationNotSupport.InvalidXengine', 'errorMessage' => 'Group Replication is not supported because the instance has xengine tables.', ], [ 'errorCode' => 'GroupReplicationNotSupport.MemoryTooSmall', 'errorMessage' => 'Group Replication is not supported because the memory is too small.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'GroupReplicationNotSupport.TableWithoutPrimaryKey', 'errorMessage' => 'Group Replication is not supported because the instance exists table has no primary key.', ], [ 'errorCode' => 'IncorrectDBInstance', 'errorMessage' => 'The current DB instance does not support this operation.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance does not exist or is not supported.', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal_level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"542BB8D6-4268-45CC-A557-B03EFD7AB30A\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"7463B73D-35CC-4D19-A010-6B8D65D242EF\\",\\n \\"HostId\\": \\"rds.aliyuncs.com\\",\\n \\"Code\\": \\"UnsupportedOperation\\",\\n \\"Message\\": \\"The specified action is not supported.\\"\\n}"},{"type":"xml","example":"\\n 542BB8D6-4268-45CC-A557-B03EFD7AB30A\\n","errorExample":""}]', 'title' => 'ModifyParameter', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" .'* MariaDB'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.'."\n" ."\n" .'* [Modify the parameters of an ApsaraDB RDS for MySQL instance](~~96063~~)'."\n" .'* [Modify the parameters of an ApsaraDB RDS for PostgreSQL instance](~~96751~~)'."\n" .'* [Modify the parameters of an ApsaraDB RDS for SQL Server instance](~~95667~~)'."\n" .'* [Modify the parameters of an ApsaraDB RDS for MariaDB instance](~~97130~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ModifyParameterGroup' => [ 'summary' => 'Modifies the parameter template of an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'ParameterGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The parameter template ID. You can call the DescribeParameterGroups operation to query the parameter template ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rpg-13ppdh****', ], ], [ 'name' => 'ParameterGroupName', 'in' => 'query', 'schema' => [ 'description' => 'The parameter template name.'."\n" ."\n" .'* The name can contain letters, digits, periods (.), and underscores (\\_). It must start with a letter.'."\n" .'* It can be 8 to 64 characters in length.'."\n" ."\n" .'> If you do not specify this parameter, the original name of the parameter template is retained.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testgroup1', ], ], [ 'name' => 'ParameterGroupDesc', 'in' => 'query', 'schema' => [ 'description' => 'The new description of the parameter template. The description can be up to 200 characters in length.'."\n" ."\n" .'> If you do not specify this parameter, the original description of the parameter template is retained.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', ], ], [ 'name' => 'Parameters', 'in' => 'query', 'schema' => [ 'description' => 'A JSON string that consists of parameters and their values in the parameter template. Format: {"Parameter 1":"Value of Parameter 1","Parameter 2":"Value of Parameter 2"...}. For more information about the parameters that can be modified, see [Modify the parameters of an ApsaraDB RDS for MySQL instance](~~96063~~) or [Modify the parameters of an ApsaraDB RDS for PostgreSQL instance](~~96751~~).'."\n" ."\n" .'> * If **ModifyMode** is set to **Individual** and this parameter is specified, the new parameters overwrite the parameters in the original parameter template.'."\n" .'> * If you set **ModifyMode** to **Collectivity** and specify this parameter, the new parameters are added to the original parameter template, or the parameters in the original parameter template are modified.'."\n" .'> * If you do not specify this parameter, the parameters in the original parameter template remain unchanged.', 'type' => 'string', 'required' => false, 'example' => '{"back_log":"3000"}', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the DescribeRegions operation to query the most recent region list.'."\n" ."\n" .'> The region of a parameter template cannot be changed. You can call the CloneParameterGroup operation to replicate a parameter template to a specific region.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'ModifyMode', 'in' => 'query', 'schema' => [ 'description' => 'The modification mode of the parameter template. Valid values:'."\n" ."\n" .'* **Collectivity** (default): adds new parameters or modifies parameters in the original parameter template.'."\n" ."\n" .'> If you set the ModifyMode parameter to Collectivity, the system adds the value of the **Parameters** parameter to the original parameter template or modifies the corresponding parameters in the original parameter template. Other parameters in the original parameter template are not affected.'."\n" ."\n" .'* **Individual**: overwrites original parameters.'."\n" ."\n" .'> If you set the ModifyMode parameter to Individual, the system uses the value of the **Parameters** parameter to overwrite the parameter settings in the original parameter template.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Collectivity', 'enum' => [ 'Individual', 'Collectivity', ], ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The resource group ID. You can call the DescribeDBInstanceAttribute operation to query the resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'ParameterGroupId' => [ 'description' => 'The parameter template ID.'."\n", 'type' => 'string', 'example' => 'rpg-13ppdh****', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '857DC00B-7B85-4853-8B27-AD65EB618BC6', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidParameters.Malformed', 'errorMessage' => 'The specified parameter "Parameters" is not valid.', ], [ 'errorCode' => 'ParamGroupsNotExist', 'errorMessage' => 'This paramGroups not exist', ], [ 'errorCode' => '%s', 'errorMessage' => 'The following parameters are prohibited:
%s', ], [ 'errorCode' => 'ParamGroupsNameInvalid', 'errorMessage' => 'The parameter group name is invalid.', ], [ 'errorCode' => 'InvalidParameterGroupId.Malformed', 'errorMessage' => 'Specified parameterGroupId is not valid.', ], [ 'errorCode' => 'ParamGroupsNotExistOrTypeNotSupport', 'errorMessage' => 'The parameter group does not exist or its type is not supported.', ], [ 'errorCode' => 'ParamNotExist', 'errorMessage' => 'This param Not Exist', ], [ 'errorCode' => 'ParamTypeError', 'errorMessage' => 'The parameter type error.', ], [ 'errorCode' => 'ParamGroupsDescInvalid', 'errorMessage' => 'The maximum length of parameter group description is exceeded.', ], [ 'errorCode' => 'InvalidParameterValue.NotStandard', 'errorMessage' => 'Invalid parameter format.', ], [ 'errorCode' => 'InvalidParameters.Prohibited', 'errorMessage' => 'Specified parameter is not valid: %s.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"ParameterGroupId\\": \\"rpg-13ppdh****\\",\\n \\"RequestId\\": \\"857DC00B-7B85-4853-8B27-AD65EB618BC6\\"\\n}","errorExample":""},{"type":"xml","example":"\\n rpg-13ppdh****\\n 857DC00B-7B85-4853-8B27-AD65EB618BC6\\n","errorExample":""}]', 'title' => 'ModifyParameterGroup', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.'."\n" ."\n" .'* [Use a parameter template to configure the parameters of ApsaraDB RDS for MySQL instances](~~130565~~)'."\n" .'* [Use a parameter template to configure the parameters of ApsaraDB RDS for PostgreSQL instances](~~457176~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeParameters' => [ 'summary' => 'Queries the parameter settings of an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCzxxxxx', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-uf6wjk5xxxxxxx', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'ConfigParameters' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'DBInstanceParameter' => [ 'description' => 'The list of parameters that are being synchronized.'."\n" ."\n" .'> After you modify and submit the parameters, you must wait for the parameters to be synchronized to the instance. After the synchronization, you can delete the parameters from the list.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'ParameterDescription' => [ 'description' => 'The description of the parameter.'."\n", 'type' => 'string', 'example' => 'This parameter sets the default fill factor value at the server scope. A fill factor is provided to optimize index data storage and performance.'."\n", ], 'ParameterName' => [ 'description' => 'The name of the parameter.'."\n", 'type' => 'string', 'example' => 'fill factor', ], 'ParameterValue' => [ 'description' => 'The value of the parameter.'."\n", 'type' => 'string', 'example' => '50', ], ], ], ], ], ], 'Engine' => [ 'description' => 'The type of the database engine.'."\n", 'type' => 'string', 'example' => 'MySQL', ], 'EngineVersion' => [ 'description' => 'The version of the database engine.'."\n", 'type' => 'string', 'example' => '5.5', ], 'ParamGroupInfo' => [ 'description' => 'The information about the parameter template.'."\n", 'type' => 'object', 'properties' => [ 'ParamGroupId' => [ 'description' => 'The ID of the parameter template.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rpg-sys-01040401010200', ], 'ParameterGroupDesc' => [ 'description' => 'The description of the parameter template.'."\n", 'type' => 'string', 'example' => 'sync_binlog=1000, innodb_flush_log_at_trx_commit=2, async', ], 'ParameterGroupName' => [ 'description' => 'The name of the parameter template.'."\n", 'type' => 'string', 'example' => 'mysql_innodb_8.0_basic_normal_high', ], 'ParameterGroupType' => [ 'description' => 'The type of the parameter template.'."\n", 'type' => 'string', 'example' => '0', ], ], ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', ], 'RunningParameters' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'DBInstanceParameter' => [ 'description' => 'The parameters that are in use.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details of the parameter that is in use.'."\n", 'type' => 'object', 'properties' => [ 'ParameterDefaultValue' => [ 'description' => 'The default value of the parameter.'."\n", 'type' => 'string', 'example' => '100', ], 'ParameterDescription' => [ 'description' => 'The description of the parameter.'."\n", 'type' => 'string', 'example' => 'This parameter sets the default fill factor value at the server scope. A fill factor is provided to optimize index data storage and performance.'."\n", ], 'ParameterName' => [ 'description' => 'The name of the parameter.'."\n", 'type' => 'string', 'example' => 'fill factor', ], 'ParameterValue' => [ 'description' => 'The value of the parameter.'."\n", 'type' => 'string', 'example' => '0', ], 'ParameterValueRange' => [ 'description' => 'The valid values of the parameter.'."\n", 'type' => 'string', 'example' => '1~100', ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'ConcurrentLimit', 'errorMessage' => 'The request processing has been concurrent limit.', ], [ 'errorCode' => 'DbossGeneralError', 'errorMessage' => 'The instance is being created. Please wait.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'Specified instance does not exist or not support.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 408 => [ [ 'errorCode' => 'NetworkOrSqlTimeoutError', 'errorMessage' => 'Failed to create login due to potential SQL Server overload or other issues that may cause the login creation fail. Please retry later.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"ConfigParameters\\": {\\n \\"DBInstanceParameter\\": [\\n {\\n \\"ParameterDescription\\": \\"The amount in bytes by which to increase a per-transaction memory pool which needs memory. See the description of transaction_prealloc_size.\\",\\n \\"ParameterName\\": \\"transaction_alloc_block_size\\",\\n \\"ParameterValue\\": \\"8192\\"\\n }\\n ]\\n },\\n \\"Engine\\": \\"MySQL\\",\\n \\"EngineVersion\\": \\"8.0\\",\\n \\"ParamGroupInfo\\": {\\n \\"ParamGroupId\\": \\"rpg-sys-01040401010200\\",\\n \\"ParameterGroupDesc\\": \\"sync_binlog=1000, innodb_flush_log_at_trx_commit=2, async\\",\\n \\"ParameterGroupName\\": \\"mysql_innodb_8.0_basic_normal_high\\",\\n \\"ParameterGroupType\\": \\"0\\"\\n },\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"RunningParameters\\": {\\n \\"DBInstanceParameter\\": [\\n {\\n \\"ParameterDefaultValue\\": \\"100\\",\\n \\"ParameterDescription\\": \\"The amount in bytes by which to increase a per-transaction memory pool which needs memory. See the description of transaction_prealloc_size.\\",\\n \\"ParameterName\\": \\"transaction_alloc_block_size\\",\\n \\"ParameterValue\\": \\"1024\\",\\n \\"ParameterValueRange\\": \\"1~100\\"\\n }\\n ]\\n }\\n}","errorExample":"{\\n \\"RequestId\\": \\"7463B73D-35CC-4D19-A010-6B8D65D242EF\\",\\n \\"HostId\\": \\"rds.aliyuncs.com\\",\\n \\"Code\\": \\"UnsupportedOperation\\",\\n \\"Message\\": \\"The specified action is not supported.\\"\\n}"},{"type":"xml","example":"\\n\\n\\t\\n\\t\\t\\n\\t\\t\\t此选项设置服务器范围内的默认填充因子值。提供填充因子是为了优化索引数据存储和性能。\\n\\t\\t\\tfill factor\\n\\t\\t\\t50\\n\\t\\t\\n\\t\\n\\tmssql\\n\\t2008r2\\n\\t\\n\\t\\t\\n\\t\\t\\t此选项设置服务器范围内的默认填充因子值。提供填充因子是为了优化索引数据存储和性能。\\n\\t\\t\\tfill factor\\n\\t\\t\\t0\\n\\t\\t\\n\\t\\n\\t2A748162-8040-4D6B-813E-6910C8C033F1\\n\\n\\t\\n","errorExample":""}]', 'title' => 'DescribeParameters', 'description' => '### Applicable engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" .'* MariaDB'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeModifyParameterLog' => [ 'summary' => 'Queries the parameter modification logs of an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-uf6wjk5xxxxx', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => true, 'example' => '2020-03-01T00:00Z', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => 'The end of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => true, 'example' => '2020-03-01T10:00Z', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page. Valid values:'."\n" ."\n" .'* **30**'."\n" .'* **50**'."\n" .'* **100**'."\n" ."\n" .'Default value: **30**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '30', 'example' => '30', 'default' => '30', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => 'The page number. Pages start from 1.'."\n" ."\n" .'Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'default' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'DBInstanceId' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5xxxxx', ], 'Engine' => [ 'description' => 'The database engine of the instance.'."\n", 'type' => 'string', 'example' => 'mysql', ], 'EngineVersion' => [ 'description' => 'The database engine version of the instance.'."\n", 'type' => 'string', 'example' => '5.6', ], 'Items' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'ParameterChangeLog' => [ 'description' => 'The log entries.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details of the log entry.'."\n", 'type' => 'object', 'properties' => [ 'ModifyTime' => [ 'description' => 'The time when the parameter was modified. This value is a UNIX timestamp. Unit: milliseconds.'."\n", 'type' => 'string', 'example' => '1584076066000', ], 'NewParameterValue' => [ 'description' => 'The new value of the parameter.'."\n", 'type' => 'string', 'example' => '3', ], 'OldParameterValue' => [ 'description' => 'The original value of the parameter.'."\n", 'type' => 'string', 'example' => '8', ], 'ParameterName' => [ 'description' => 'The name of the parameter.'."\n", 'type' => 'string', 'example' => 'innodb_stats_sample_pages', ], 'Status' => [ 'description' => 'The status. Valid values:'."\n" ."\n" .'* **Applied:** The new value has taken effect.'."\n" .'* **Syncing:** The new value is being applied and has not taken effect.'."\n", 'type' => 'string', 'example' => 'Syncing', ], ], ], ], ], ], 'PageNumber' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageRecordCount' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'C8E88DED-533F-4B3C-9207-731FBF394CCA', ], 'TotalRecordCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBInstanceId\\": \\"rm-uf6wjk5****\\",\\n \\"Engine\\": \\"mysql\\",\\n \\"EngineVersion\\": \\"5.6\\",\\n \\"Items\\": {\\n \\"ParameterChangeLog\\": [\\n {\\n \\"ModifyTime\\": \\"1584076066000\\",\\n \\"NewParameterValue\\": \\"3\\",\\n \\"OldParameterValue\\": \\"8\\",\\n \\"ParameterName\\": \\"innodb_stats_sample_pages\\",\\n \\"Status\\": \\"Syncing\\"\\n }\\n ]\\n },\\n \\"PageNumber\\": 1,\\n \\"PageRecordCount\\": 1,\\n \\"RequestId\\": \\"C8E88DED-533F-4B3C-9207-731FBF394CCA\\",\\n \\"TotalRecordCount\\": 1\\n}","errorExample":""},{"type":"xml","example":"\\n5.6\\nmysql\\nC8E88DED-533F-4B3C-9207-731FBF394CCA\\nrm-uf6wjk5xxxxx\\n1\\n1\\n1\\n\\n \\n Syncing\\n 1584076066000\\n 3\\n 8\\n innodb_stats_sample_pages\\n \\n\\n","errorExample":""}]', 'title' => 'DescribeModifyParameterLog', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" .'* MariaDB'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeParameterTemplates' => [ 'summary' => 'Queries parameter templates.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxx', ], ], [ 'name' => 'Engine', 'in' => 'query', 'schema' => [ 'description' => 'The database engine of the instance. Valid values:'."\n" ."\n" .'* **mysql**: MySQL'."\n" .'* **mssql**: SQL Server'."\n" .'* **PostgreSQL**: PostgreSQL'."\n" .'* **MariaDB**: MariaDB'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'mysql', ], ], [ 'name' => 'EngineVersion', 'in' => 'query', 'schema' => [ 'description' => 'The version of the database engine. Valid values:'."\n" ."\n" .'* Valid values when you set the Engine parameter to mysql: **5.5, 5.6, 5.7, and 8.0**.'."\n" .'* Valid values when you set the Engine parameter to mssql: **2008r2**.'."\n" .'* Valid values when you set the Engine parameter to PostgreSQL: **10.0, 11.0, 12.0, 13.0, 14.0, and 15.0**.'."\n" .'* Valid values when you set the Engine parameter to MariaDB: **10.3**.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '8.0', ], ], [ 'name' => 'Category', 'in' => 'query', 'schema' => [ 'description' => 'The RDS edition of the instance. Valid values:'."\n" ."\n" .'* **Basic**: RDS Basic Edition'."\n" .'* **HighAvailability**: RDS High-availability Edition'."\n" .'* **Finance**: RDS Enterprise Edition'."\n", 'type' => 'string', 'required' => false, 'example' => 'Basic', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'rm-bp1imnm**********', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Engine' => [ 'description' => 'The database engine of the instance.'."\n", 'type' => 'string', 'example' => 'mysql', ], 'EngineVersion' => [ 'description' => 'The version of the database engine.'."\n", 'type' => 'string', 'example' => '8.0', ], 'ParameterCount' => [ 'description' => 'The number of parameters.'."\n", 'type' => 'string', 'example' => '2', ], 'Parameters' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'TemplateRecord' => [ 'description' => 'The details of the parameters.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'CheckingCode' => [ 'description' => 'The valid values of the parameter.'."\n", 'type' => 'string', 'example' => '[0-1024]', ], 'ForceModify' => [ 'description' => 'Indicates whether the parameter can be modified. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'string', 'example' => 'true', ], 'ForceRestart' => [ 'description' => 'Indicates whether you must restart the instance for the modifications to take effect. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'string', 'example' => 'false', ], 'ParameterDescription' => [ 'description' => 'The description of the parameter.'."\n", 'type' => 'string', 'example' => 'Page numbers of multi blocks reading once in some ddl query.', ], 'ParameterName' => [ 'description' => 'The name of the parameter.'."\n", 'type' => 'string', 'example' => 'loose_multi_blocks_ddl_count', ], 'ParameterValue' => [ 'description' => 'The default value of the parameter.'."\n", 'type' => 'string', 'example' => '0', ], ], ], ], ], ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0F9B7410-EC73-510C-B385-8339455C12C6', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Invalid.ParamGroupDBCategory', 'errorMessage' => 'Invalid parameter group category', ], [ 'errorCode' => 'ParameterIllegal', 'errorMessage' => 'Param is illegal parameter.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Engine\\": \\"mysql\\",\\n \\"EngineVersion\\": \\"8.0\\",\\n \\"ParameterCount\\": \\"2\\",\\n \\"Parameters\\": {\\n \\"TemplateRecord\\": [\\n {\\n \\"CheckingCode\\": \\"[0-1024]\\",\\n \\"ForceModify\\": \\"true\\",\\n \\"ForceRestart\\": \\"false\\",\\n \\"ParameterDescription\\": \\"Page numbers of multi blocks reading once in some ddl query.\\",\\n \\"ParameterName\\": \\"loose_multi_blocks_ddl_count\\",\\n \\"ParameterValue\\": \\"0\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"0F9B7410-EC73-510C-B385-8339455C12C6\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 2\\n 8.0\\n \\n \\n true\\n [OFF|ON]\\n OFF\\n false\\n loose_recycle_scheduler\\n Switch of purge thread.\\n \\n \\n true\\n [0-1024]\\n 0\\n false\\n loose_multi_blocks_ddl_count\\n Page numbers of multi blocks reading once in some ddl query.\\n \\n \\n 0F9B7410-EC73-510C-B385-8339455C12C6\\n mysql\\n","errorExample":""}]', 'title' => 'DescribeParameterTemplates', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" .'* MariaDB'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeParameterGroups' => [ 'summary' => 'Queries the parameter templates that are available in a region.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy****', ], ], [ 'name' => 'EnableDetail', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to return the parameter overview.'."\n" ."\n" .'* **false** (default): The parameter overview is returned.'."\n" .'* **true**: The parameter overview is not returned.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'ParameterGroups' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'ParameterGroup' => [ 'description' => 'The details of the parameter templates.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'CreateTime' => [ 'description' => 'The time when the parameter template was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2019-11-21T01:48:39Z', ], 'Engine' => [ 'description' => 'The database engine of the instance.'."\n", 'type' => 'string', 'example' => 'mysql', ], 'EngineVersion' => [ 'description' => 'The database engine version.'."\n", 'type' => 'string', 'example' => '5.7', ], 'ForceRestart' => [ 'description' => 'Indicates whether the restart of an instance is required for the parameter template to take effect. Valid values:'."\n" ."\n" .'* 0: A restart is not required.'."\n" .'* 1: A restart is required.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'ParamCounts' => [ 'description' => 'The number of parameters in the parameter template.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'ParameterGroupDesc' => [ 'description' => 'The type of the parameter template. Valid values:'."\n" ."\n" .'* 0: the default parameter template.'."\n" .'* 1: a custom parameter template.'."\n" .'* 2: an automatic backup parameter template. After you apply this type of template, the system automatically backs up the original parameter settings and saves the backup as a template.'."\n", 'type' => 'string', 'example' => '1', ], 'ParameterGroupId' => [ 'description' => 'The ID of the parameter template.'."\n", 'type' => 'string', 'example' => 'rpg-****', ], 'ParameterGroupName' => [ 'description' => 'The name of the parameter template.'."\n", 'type' => 'string', 'example' => 'test1234', ], 'ParameterGroupType' => [ 'description' => 'The type of the parameter template. Valid values:'."\n" ."\n" .'* 0: the default parameter template.'."\n" .'* 1: a custom parameter template.'."\n" .'* 2: an automatic backup parameter template. After you apply this type of template, the system automatically backs up the original parameter settings and saves the backup as a template.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'UpdateTime' => [ 'description' => 'The time when the parameter template was last updated. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2019-11-21T02:21:35Z', ], ], ], ], ], ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'D4A23265-C5B6-42E1-98A0-EFA1EB42E723', ], 'SignalForOptimizeParams' => [ 'description' => 'Indicates whether parameter templates exist in the specified region. Valid values:'."\n" .'* true'."\n" .'* false'."\n" .'>This parameter is deprecated.>', 'type' => 'boolean', 'example' => 'false', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidUID.Duplicate', 'errorMessage' => 'Specified uid is not valid.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"ParameterGroups\\": {\\n \\"ParameterGroup\\": [\\n {\\n \\"CreateTime\\": \\"2019-11-21T01:48:39Z\\",\\n \\"Engine\\": \\"mysql\\",\\n \\"EngineVersion\\": \\"5.7\\",\\n \\"ForceRestart\\": 1,\\n \\"ParamCounts\\": 2,\\n \\"ParameterGroupDesc\\": \\"1\\",\\n \\"ParameterGroupId\\": \\"rpg-****\\",\\n \\"ParameterGroupName\\": \\"test1234\\",\\n \\"ParameterGroupType\\": 1,\\n \\"UpdateTime\\": \\"2019-11-21T02:21:35Z\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"D4A23265-C5B6-42E1-98A0-EFA1EB42E723\\",\\n \\"SignalForOptimizeParams\\": false\\n}","errorExample":""},{"type":"xml","example":"\\n false\\n D4A23265-C5B6-42E1-98A0-EFA1EB42E723\\n \\n 2019-11-21T02:21:35Z\\n 1\\n 2019-11-21T01:48:39Z\\n 1\\n rpg-****\\n test1234\\n mysql\\n 2\\n 5.7\\n 1\\n \\n","errorExample":""}]', 'title' => 'DescribeParameterGroups', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.'."\n" ."\n" .'* [Use a parameter template to configure the parameters of ApsaraDB RDS for MySQL instances](~~130565~~)'."\n" .'* [Use a parameter template to configure the parameters of ApsaraDB RDS for PostgreSQL instances](~~457176~~)'."\n", ], 'DescribeParameterGroup' => [ 'summary' => 'Queries the information about a parameter template.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'ParameterGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The parameter template ID. You can call the DescribeParameterGroups operation to query the parameter template ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rpg-dp****', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'ParamGroup' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'ParameterGroup' => [ 'description' => 'The information about the parameter template.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'CreateTime' => [ 'description' => 'The time when the parameter template was created.'."\n", 'type' => 'string', 'example' => '2019-10-22T06:02:53Z', ], 'Engine' => [ 'description' => 'The database engine of the instance.'."\n", 'type' => 'string', 'example' => 'mysql', ], 'EngineVersion' => [ 'description' => 'The database engine version of the instance.'."\n", 'type' => 'string', 'example' => '5.6', ], 'ForceRestart' => [ 'description' => 'Indicates whether the restart of an instance is required for the parameter template to take effect. Valid values:'."\n" ."\n" .'* **0**: A restart is not required.'."\n" .'* **1**: A restart is required.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'ParamCounts' => [ 'description' => 'The number of parameters in the parameter template.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'ParamDetail' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'ParameterDetail' => [ 'description' => 'The details of the parameters.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'ParamName' => [ 'description' => 'The name of the parameter.'."\n", 'type' => 'string', 'example' => 'back_log', ], 'ParamValue' => [ 'description' => 'The value of the parameter.'."\n", 'type' => 'string', 'example' => '2000', ], ], ], ], ], ], 'ParameterGroupDesc' => [ 'description' => 'The description of the parameter template.'."\n", 'type' => 'string', 'example' => 'testGroup1', ], 'ParameterGroupId' => [ 'description' => 'The ID of the parameter template.'."\n", 'type' => 'string', 'example' => 'rpg-dp****', ], 'ParameterGroupName' => [ 'description' => 'The name of the parameter template.'."\n", 'type' => 'string', 'example' => 'test123456', ], 'ParameterGroupType' => [ 'description' => 'The type of the parameter template. Valid values:'."\n" ."\n" .'* **0**: the default parameter template.'."\n" .'* **1**: a custom parameter template.'."\n" .'* **2**: an automatic backup parameter template. After you apply this type of template, the system automatically backs up the original parameter settings and saves the backup as a template.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'UpdateTime' => [ 'description' => 'The time when the parameter template was last updated. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2019-10-22T06:07:54Z', ], ], ], ], ], ], 'RelatedCustinsInfo' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'RelatedCustinsInfo' => [ 'description' => 'The information about the instance to which the parameter template is applied.'."\n" ."\n" .'> This parameter is available only for ApsaraDB RDS for PostgreSQL instances.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'AppliedTime' => [ 'description' => 'The time when the parameter template was applied.'."\n", 'type' => 'string', 'example' => '2022-10-17T03:19:02Z', ], 'DBInstanceName' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-bp170****', ], ], ], ], ], ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '498AE8CA-8C81-4A01-AF37-2B902014ED30', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'ParamGroupsNotExist', 'errorMessage' => 'The specified paramGroups does not exist.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], [ 'errorCode' => 'ParamGroupOptionValue.NotFound', 'errorMessage' => 'Specified system parameter group option value not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"ParamGroup\\": {\\n \\"ParameterGroup\\": [\\n {\\n \\"CreateTime\\": \\"2019-10-22T06:02:53Z\\",\\n \\"Engine\\": \\"mysql\\",\\n \\"EngineVersion\\": \\"5.6\\",\\n \\"ForceRestart\\": 1,\\n \\"ParamCounts\\": 2,\\n \\"ParamDetail\\": {\\n \\"ParameterDetail\\": [\\n {\\n \\"ParamName\\": \\"back_log\\",\\n \\"ParamValue\\": \\"2000\\"\\n }\\n ]\\n },\\n \\"ParameterGroupDesc\\": \\"testGroup1\\",\\n \\"ParameterGroupId\\": \\"rpg-dp****\\",\\n \\"ParameterGroupName\\": \\"test123456\\",\\n \\"ParameterGroupType\\": 1,\\n \\"UpdateTime\\": \\"2019-10-22T06:07:54Z\\"\\n }\\n ]\\n },\\n \\"RelatedCustinsInfo\\": {\\n \\"RelatedCustinsInfo\\": [\\n {\\n \\"AppliedTime\\": \\"2022-10-17T03:19:02Z\\",\\n \\"DBInstanceName\\": \\"rm-bp170****\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"498AE8CA-8C81-4A01-AF37-2B902014ED30\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 498AE8CA-8C81-4A01-AF37-2B902014ED30\\n \\n 2019-10-22T06:07:54Z\\n testGroup1\\n 2019-10-22T06:02:53Z\\n 1\\n rpg-dp****\\n test123456\\n mysql\\n 2\\n 5.6\\n 1\\n \\n back_log\\n 2000\\n \\n \\n \\n rm-bp170****\\n 2022-10-17T03:19:02Z\\n \\n","errorExample":""}]', 'title' => 'DescribeParameterGroup', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.'."\n" ."\n" .'* [Use a parameter template for an ApsaraDB RDS for MySQL instance](~~130565~~)'."\n" .'* [Use a parameter template for an ApsaraDB RDS for PostgreSQL instance](~~457176~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'CloneParameterGroup' => [ 'summary' => 'Replicates a parameter template to the current region or another region.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'create', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the source region to which the parameter template belongs. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'TargetRegionId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the destination region. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-qingdao', ], ], [ 'name' => 'ParameterGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the parameter template. You can call the DescribeParameterGroups operation to query the parameter template ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rpg-13ppdh****', ], ], [ 'name' => 'ParameterGroupName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the parameter template in the destination region.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'tartestgroup', ], ], [ 'name' => 'ParameterGroupDesc', 'in' => 'query', 'schema' => [ 'description' => 'The description of the parameter template in the destination region.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'CloneGroup1', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the resource group. You can leave this parameter empty.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1D3D5995-6BDD-43B5-93B8-2C41A2ACD6AA', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidParameterGroupId.Malformed', 'errorMessage' => 'Specified parameterGroupId is not valid.', ], [ 'errorCode' => 'InvalidEngine.Malformed', 'errorMessage' => 'Specified engine is not valid.', ], [ 'errorCode' => 'InvalidEngineVersion.Malformed', 'errorMessage' => 'Specified engine version is not valid.', ], [ 'errorCode' => 'ParamNotExist', 'errorMessage' => 'This param Not Exist', ], [ 'errorCode' => 'ParamTypeError', 'errorMessage' => 'The parameter type error.', ], [ 'errorCode' => 'ParamGroupOptionValue.NotSupport', 'errorMessage' => 'Specified option value unsupported.', ], [ 'errorCode' => 'ParamGroupsNotExist', 'errorMessage' => 'The specified paramGroups does not exist.', ], [ 'errorCode' => 'InvalidParameters.Malformed', 'errorMessage' => 'One or more of the request parameters provided are not valid.', ], [ 'errorCode' => '%s', 'errorMessage' => 'The following parameters are prohibited:
%s', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'ParamGroupOptionKey.NotFound', 'errorMessage' => 'Specified system parameter group option unregistered.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1D3D5995-6BDD-43B5-93B8-2C41A2ACD6AA\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n1D3D5995-6BDD-43B5-93B8-2C41A2ACD6AA\\r\\n","errorExample":""}]', 'title' => 'CloneParameterGroup', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.'."\n" ."\n" .'* [Use a parameter template to configure the parameters of ApsaraDB RDS for MySQL instances](~~130565~~)'."\n" .'* [Use a parameter template to configure the parameters of ApsaraDB RDS for PostgreSQL instances](~~457176~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescibeImportsFromDatabase' => [ 'summary' => 'Queries the migration tasks of an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'list', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxx', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the IDs of instances.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-bpxxxxx', ], ], [ 'name' => 'Engine', 'in' => 'query', 'schema' => [ 'description' => 'The database engine of the instance. Set the value to **MySQL**'."\n", 'type' => 'string', 'required' => true, 'example' => 'MySQL', ], ], [ 'name' => 'ImportId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the migration task.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '123', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => true, 'example' => '2011-06-11T15:00Z', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => 'The end of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => true, 'example' => '2011-06-11T16:00Z', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Valid values:'."\n" ."\n" .'* **30**'."\n" .'* **50**'."\n" .'* **100**'."\n" ."\n" .'Default value: **30**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'default' => '30', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => 'The page number. Valid values: any non-zero positive integer.'."\n" ."\n" .'Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the resource group. You can call the DescribeDBInstanceAttribute operation to obtain the ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy*****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Items' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'ImportResultFromDB' => [ 'description' => 'The migration tasks.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'ImportDataStatus' => [ 'description' => 'The status of the migration task. Valid values:'."\n" ."\n" .'* **NotStart**: The migration task has not started.'."\n" .'* **FullExporting**: The migration task is exporting full data.'."\n" .'* **FullImporting**: The migration task is importing full data.'."\n" .'* **Success**: The migration task is successful.'."\n" .'* **Failed**: The migration task failed.'."\n" .'* **Canceled**: The migration task is canceled.'."\n" .'* **Canceling**: The migration task is being canceled.'."\n" .'* **IncrementalWaiting**: The migration task is waiting to synchronize incremental data.'."\n" .'* **IncrementalImporting**: The migration task is synchronizing incremental data.'."\n" .'* **StopSyncing**: The migration task stops synchronizing data.'."\n", 'type' => 'string', 'example' => 'NotStart', ], 'ImportDataStatusDescription' => [ 'description' => 'The description of the migration task.'."\n", 'type' => 'string', 'example' => 'Description'."\n", ], 'ImportDataType' => [ 'description' => 'The type of the migration task. Valid values:'."\n" ."\n" .'* **Full**: full migration'."\n" .'* **Incremental:**: incremental migration'."\n", 'type' => 'string', 'example' => 'Full', ], 'ImportId' => [ 'description' => 'The ID of the migration task.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '123', ], 'IncrementalImportingTime' => [ 'description' => 'The time when the migration task synchronized incremental data. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2011-06-11T15:00Z', ], ], ], ], ], ], 'PageNumber' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageRecordCount' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'B000AA91-393D-46F9-8D9B-098E28931A3A', ], 'TotalRecordCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidMigrationType.Format', 'errorMessage' => 'Specified migration type is not valid.', ], [ 'errorCode' => 'InvalidPageNumbers.Malformed', 'errorMessage' => 'Specified page number is not valid.', ], [ 'errorCode' => 'ParameterLeastAssociate', 'errorMessage' => 'Must input at least one optional parameter', ], [ 'errorCode' => 'InvalidParameterCombination', 'errorMessage' => 'The end time must be greater than the start time', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OperationDenied.DBInstanceType', 'errorMessage' => 'The operation is not permitted due to type of instance.', ], [ 'errorCode' => 'InvalidMaxRecordsPerPage.Malformed', 'errorMessage' => 'Specified record number is not valid.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'Invalid DBInstanceId NotFound.', ], [ 'errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'Specified instance does not exist or not support.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Items\\": {\\n \\"ImportResultFromDB\\": [\\n {\\n \\"ImportDataStatus\\": \\"NotStart\\",\\n \\"ImportDataStatusDescription\\": \\"描述信息。\\",\\n \\"ImportDataType\\": \\"Full\\",\\n \\"ImportId\\": 123,\\n \\"IncrementalImportingTime\\": \\"2023-06-11T15:00Z\\"\\n }\\n ]\\n },\\n \\"PageNumber\\": 1,\\n \\"PageRecordCount\\": 1,\\n \\"RequestId\\": \\"B000AA91-393D-46F9-8D9B-098E28931A3A\\",\\n \\"TotalRecordCount\\": 1\\n}","errorExample":""},{"type":"xml","example":"\\n0\\n30\\nB000AA91-393D-46F9-8D9B-098E28931A3A\\n1\\n\\n \\n 123\\n Full\\n NotStart\\n 描述信息\\n \\n \\n\\n","errorExample":""}]', 'title' => 'DescibeImportsFromDatabase', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ModifyActiveOperationTasks' => [ 'summary' => 'Changes the switching time of scheduled O\\\\\\\\\\\\&M tasks for an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'Ids', 'in' => 'query', 'schema' => [ 'description' => 'The O\\&M task ID. Separate multiple IDs with commas (,).'."\n" ."\n" .'> You can call the DescribeActiveOperationTask operation to query the O\\&M task ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '11111,22222', ], ], [ 'name' => 'SwitchTime', 'in' => 'query', 'schema' => [ 'description' => 'The scheduled switching time that you want to specify. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n" ."\n" .'> The time that is specified by the SwitchTime parameter cannot be later than the time that is specified by the Deadline parameter. You can call the DescribeActiveOperationTasks operation to query the value of the Deadline parameter in the response.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2019-10-17T18:50:00Z', ], ], [ 'name' => 'ImmediateStart', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to immediately start scheduling. Valid values:'."\n" ."\n" .'* 0 (default): no'."\n" .'* 1: yes'."\n" ."\n" .'> '."\n" ."\n" .'* If you set this parameter to 0, the SwitchTime parameter takes effect. If you set this parameter to 1, the SwitchTime parameter does not take effect. In this case, the start time of the task is the current time, and the system determines the switching time based on the start time.'."\n" ."\n" .'* Immediate scheduling specifies that the task enters the preparing state instead of being executed immediately. After the preparation is complete, the switchover is performed. You can call the DescribeActiveOperationTasks to query the preparation time that is returned for the PrepareInterval parameter.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Ids' => [ 'description' => 'The ID of the O\\&M task. IDs are separated by commas (,).'."\n", 'type' => 'string', 'example' => '11111,22222', ], 'RequestId' => [ 'description' => 'The ID of the region.'."\n", 'type' => 'string', 'example' => 'E9ADB6BE-1598-57FC-B86D-D7F4C69B****', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'StartTimeBeforeNow', 'errorMessage' => 'The start time should be later than current time.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'InvalidTime.Format', 'errorMessage' => 'Specified time is not valid.', ], [ 'errorCode' => 'TaskModifyError', 'errorMessage' => 'Part of the tasks cannot be modified.', ], [ 'errorCode' => 'SwitchTimeAfterDeadline', 'errorMessage' => 'The switch time should be earlier than deadline.', ], [ 'errorCode' => 'IncorrectTaskType', 'errorMessage' => 'Current task does not support this operation.', ], [ 'errorCode' => 'TaskHasStarted', 'errorMessage' => 'Task has started.', ], [ 'errorCode' => 'IncorrectTaskStatus', 'errorMessage' => 'The status of certain task does not support this operation.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'InvalidRequest', 'errorMessage' => 'Invalid Request.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], [ 'errorCode' => 'InvalidParams.RecordNotFound', 'errorMessage' => 'No records found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Ids\\": \\"11111,22222\\",\\n \\"RequestId\\": \\"E9ADB6BE-1598-57FC-B86D-D7F4C69B****\\"\\n}","type":"json"}]', 'title' => 'ModifyActiveOperationTasks', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" .'* MariaDB'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> : Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.'."\n" ."\n" .'* [Scheduled events for ApsaraDB RDS for MySQL instances](~~104183~~)'."\n" .'* [Scheduled events for ApsaraDB RDS for PostgreSQL instances](~~104452~~)'."\n" .'* [Scheduled events for ApsaraDB RDS for SQL Server instances](~~104451~~)'."\n" .'* [Scheduled events for ApsaraDB RDS for MariaDB instances](~~104454~~)'."\n", ], 'DescribeActiveOperationTasks' => [ 'summary' => 'Queries the details about scheduled O\\\\\\\\\\\\\\\\\\\\&M tasks for an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'Region', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the pending event. You can call the DescribeRegions operation to query the most recent region list.'."\n" ."\n" .'> The value **all** indicates all regions.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'cn-beijing', ], ], [ 'name' => 'TaskType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the task. Valid values:'."\n" ."\n" .'* **rds_apsaradb_ha**: primary/secondary switchover'."\n" .'* **rds_apsaradb_transfer**: instance migration'."\n" .'* **rds_apsaradb_upgrade**: update of the minor engine version'."\n" .'* **rds_apsaradb_maxscale**: update of the minor version of the proxy'."\n" .'* **all**: all types'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'rds_apsaradb_upgrade', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page. Default value: 25. Maximum value: 100.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '10', 'example' => '25', 'default' => '30', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'default' => '1', ], ], [ 'name' => 'ProductId', 'in' => 'query', 'schema' => [ 'description' => 'The name of the service. Valid values: RDS, POLARDB, MongoDB, and Redis. For RDS instances, set the value to RDS.'."\n", 'type' => 'string', 'required' => false, 'example' => 'RDS', ], ], [ 'name' => 'DbType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the database. Default value: all. Valid values: mysql, pgsql, and mssql.'."\n", 'type' => 'string', 'required' => false, 'example' => 'all', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'The status of the task, which is used as a filter condition to return tasks.'."\n" ."\n" .'* **-1**: all tasks'."\n" .'* **3**: pending'."\n" .'* **4**: being processed'."\n" .'* **5**: completed'."\n" .'* **6**: failed'."\n" .'* **7**: canceled'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '-1', ], ], [ 'name' => 'InsName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the instance. You can leave this parameter empty. If you configure this parameter, you can specify the name only of one instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rm-bp191w771kd3****', ], ], [ 'name' => 'AllowChange', 'in' => 'query', 'schema' => [ 'description' => 'The filter condition that is used to return tasks based on the settings of the switching time. Default value: -1. Valid values:'."\n" ."\n" .'* **-1**: returns all tasks.'."\n" .'* **0**: returns only tasks for which the switching time cannot be changed.'."\n" .'* **1**: returns only tasks for which the switching time can be changed.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '-1', ], ], [ 'name' => 'AllowCancel', 'in' => 'query', 'schema' => [ 'description' => 'The filter condition that is used to return tasks based on the settings of task cancellation. Default value: -1. Valid values:'."\n" ."\n" .'* **-1**: returns all tasks.'."\n" .'* **0**: returns only tasks that cannot be canceled.'."\n" .'* **1**: returns only tasks that can be canceled.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '-1', ], ], [ 'name' => 'ChangeLevel', 'in' => 'query', 'schema' => [ 'description' => 'The filter condition that is used to return tasks based on the task level. Default value: all. Valid values:'."\n" ."\n" .'* **all**: all types'."\n" .'* **S0**: returns the tasks of the exception fixing level.'."\n" .'* **S1**: returns the tasks of the system O\\&M level.'."\n", 'type' => 'string', 'required' => false, 'example' => 'all', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Items' => [ 'description' => 'The details about the O\\&M task.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'AllowCancel' => [ 'description' => 'Indicates whether the task can be canceled. The value 1 indicates that the task can be canceled. The value 0 indicates that the task cannot be canceled.'."\n", 'type' => 'string', 'example' => '1', ], 'AllowChange' => [ 'description' => 'Indicates whether the switching time can be changed. The value 1 indicates that the switching time can be changed. The value 0 indicates that the switching time cannot be changed.'."\n", 'type' => 'string', 'example' => '1', ], 'ChangeLevel' => [ 'description' => 'The code of the task level. The value S1 indicates the system O\\&M level. The value S0 indicates the exception fixing level.'."\n", 'type' => 'string', 'example' => 'S1', ], 'ChangeLevelEn' => [ 'description' => 'The level of the task in English.'."\n", 'type' => 'string', 'example' => 'System maintenance', ], 'ChangeLevelZh' => [ 'description' => 'The level of the task in Chinese.'."\n", 'type' => 'string', 'example' => '系统运维', ], 'CreatedTime' => [ 'description' => 'The time when the task was created. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2018-05-30T14:30:00Z', ], 'CurrentAVZ' => [ 'description' => 'The current zone.'."\n", 'type' => 'string', 'example' => 'cn-beijing-h', ], 'DbType' => [ 'description' => 'The type of the database. Valid values: mysql, pgsql, and mssql.'."\n", 'type' => 'string', 'example' => 'mysql', ], 'DbVersion' => [ 'description' => 'The minor engine version.'."\n", 'type' => 'string', 'example' => '5.7', ], 'Deadline' => [ 'description' => 'The deadline of the switching time for the task. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2018-05-30T23:59:59Z', ], 'Id' => [ 'description' => 'The ID of the task.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '11111', ], 'Impact' => [ 'description' => 'The impact of the task.'."\n", 'type' => 'string', 'example' => 'TransientDisconnection', ], 'ImpactEn' => [ 'description' => 'The impact of the task in English.'."\n", 'type' => 'string', 'example' => 'Transient instance disconnection', ], 'ImpactZh' => [ 'description' => 'The impact of the task in Chinese.'."\n", 'type' => 'string', 'example' => '实例闪断', ], 'InsComment' => [ 'description' => 'The alias and description of the instance.'."\n", 'type' => 'string', 'example' => 'test', ], 'InsName' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-wz96h8jujh512****', ], 'ModifiedTime' => [ 'description' => 'The time after the modification. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2018-05-30T14:30:00Z', ], 'PrepareInterval' => [ 'description' => 'The required preparation period between the task start time and the switching time. The time is displayed in the HH:mm:ss format.'."\n", 'type' => 'string', 'example' => '04:00:00', ], 'Region' => [ 'description' => 'The region ID of the pending task.'."\n", 'type' => 'string', 'example' => 'cn-beijing', ], 'ResultInfo' => [ 'description' => 'The information about the execution result.'."\n", 'type' => 'string', 'example' => 'userCancel', ], 'StartTime' => [ 'description' => 'The time when the task was executed. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2018-05-30T00:00:00Z', ], 'Status' => [ 'description' => 'The task status.'."\n" ."\n" .'* **3**: pending'."\n" .'* **4**: being processed'."\n" .'* **5**: completed'."\n" .'* **6**: failed'."\n" .'* **7**: canceled'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'SubInsNames' => [ 'description' => 'The subtasks of the instance.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The name of the subtask.'."\n", 'type' => 'string', 'example' => 'sub1369716295573-tes2cy6****.2013052818****', ], ], 'SwitchTime' => [ 'description' => 'The switching time of the task. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2018-05-30T14:30:00Z', ], 'TaskParams' => [ 'description' => 'The task parameters.'."\n", 'type' => 'string', 'example' => '{'."\n" .' "Action": "UpgradeDBInstance"'."\n" .'}', ], 'TaskType' => [ 'description' => 'The type of the O\\&M task. Valid values:'."\n" ."\n" .'* **rds_apsaradb_ha**: primary/secondary switchover'."\n" .'* **rds_apsaradb_transfer**: instance migration'."\n" .'* **rds_apsaradb_upgrade**: update of the minor engine version'."\n" .'* **rds_apsaradb_maxscale**: minor version update of the database proxy'."\n", 'type' => 'string', 'example' => 'rds_apsaradb_upgrade', ], 'TaskTypeEn' => [ 'description' => 'The reason for the task in English.'."\n", 'type' => 'string', 'example' => 'Minor version update', ], 'TaskTypeZh' => [ 'description' => 'The reason for the task in Chinese.'."\n", 'type' => 'string', 'example' => '小版本升级', ], ], ], ], 'PageNumber' => [ 'description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries per page. Valid values: 1 to 100. Default value: 25.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '25', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'D4D4BE8A-DD46-440A-BFCD-EE31DA81****', ], 'TotalRecordCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidPageParam.Format', 'errorMessage' => 'Page param should be a positive integer.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'InvalidDBType', 'errorMessage' => 'The DB type does not support this operation.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'InvalidRequest', 'errorMessage' => 'Invalid Request.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Items\\": [\\n {\\n \\"AllowCancel\\": \\"1\\",\\n \\"AllowChange\\": \\"1\\",\\n \\"ChangeLevel\\": \\"S1\\",\\n \\"ChangeLevelEn\\": \\"System maintenance\\",\\n \\"ChangeLevelZh\\": \\"系统运维\\",\\n \\"CreatedTime\\": \\"2018-05-30T14:30:00Z\\",\\n \\"CurrentAVZ\\": \\"cn-beijing-h\\",\\n \\"DbType\\": \\"mysql\\",\\n \\"DbVersion\\": \\"5.7\\",\\n \\"Deadline\\": \\"2018-05-30T23:59:59Z\\",\\n \\"Id\\": 11111,\\n \\"Impact\\": \\"TransientDisconnection\\",\\n \\"ImpactEn\\": \\"Transient instance disconnection\\",\\n \\"ImpactZh\\": \\"实例闪断。\\",\\n \\"InsComment\\": \\"test\\",\\n \\"InsName\\": \\"rm-wz96h8jujh512****\\",\\n \\"ModifiedTime\\": \\"2018-05-30T14:30:00Z\\",\\n \\"PrepareInterval\\": \\"04:00:00\\",\\n \\"Region\\": \\"cn-beijing\\",\\n \\"ResultInfo\\": \\"userCancel\\",\\n \\"StartTime\\": \\"2018-05-30T00:00:00Z\\",\\n \\"Status\\": 3,\\n \\"SubInsNames\\": [\\n \\"sub1369716295573-tes2cy6****.2013052818****\\"\\n ],\\n \\"SwitchTime\\": \\"2018-05-30T14:30:00Z\\",\\n \\"TaskParams\\": \\"{\\\\n \\\\\\"Action\\\\\\": \\\\\\"UpgradeDBInstance\\\\\\"\\\\n}\\",\\n \\"TaskType\\": \\"rds_apsaradb_upgrade\\",\\n \\"TaskTypeEn\\": \\"Minor version update\\",\\n \\"TaskTypeZh\\": \\"小版本升级\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 25,\\n \\"RequestId\\": \\"D4D4BE8A-DD46-440A-BFCD-EE31DA81****\\",\\n \\"TotalRecordCount\\": 1\\n}","type":"json"}]', 'title' => 'DescribeActiveOperationTasks', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" .'* MariaDB'."\n", ], 'CancelActiveOperationTasks' => [ 'summary' => 'Cancels O\\\\\\&M tasks that are not started.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'Ids', 'in' => 'query', 'schema' => [ 'description' => 'The IDs of tasks that you want to cancel at a time. Separate multiple IDs with commas (,). We recommend that you configure up to 25 IDs at a time.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '188****,188****,188****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Ids' => [ 'description' => 'The IDs of the tasks that are canceled. Multiple task IDs are separated with commas (,).'."\n", 'type' => 'string', 'example' => '188****,188****,188****'."\n", ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'A807C95D-410C-5BB5-96C0-C6E09F2C3D36', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'StartTimeBeforeNow', 'errorMessage' => 'The start time should be later than current time.', ], [ 'errorCode' => 'IncorrectEventStatus', 'errorMessage' => 'Current event\'s status does not support this operation.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'InvalidRequest', 'errorMessage' => 'Invalid Request.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Ids\\": \\"188****,188****,188****\\\\n\\",\\n \\"RequestId\\": \\"A807C95D-410C-5BB5-96C0-C6E09F2C3D36\\"\\n}","type":"json"}]', 'title' => 'CancelActiveOperationTasks', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" .'* MariaDB'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> Before you call this operation, read the following topics and make sure that you fully understand the prerequisites and impacts of this operation.'."\n" ."\n" .'* [Scheduled events for ApsaraDB RDS for MySQL instances](~~104183~~)'."\n" .'* [Scheduled events for ApsaraDB RDS for PostgreSQL instances](~~104452~~)'."\n" .'* [Scheduled events for ApsaraDB RDS for SQL Server instances](~~104451~~)'."\n" .'* [Scheduled events for ApsaraDB RDS for MariaDB instances](~~104454~~)'."\n" ."\n" .'### [](#)Usage notes'."\n" ."\n" .'Tasks cannot be canceled in the following situations:'."\n" ."\n" .'* The allowCancel parameter is set to 0.'."\n" .'* The current time is later than the task start time.'."\n" .'* The status of the task is not set to 3. The value 3 specifies that the task is waiting to be executed.'."\n", 'translator' => 'machine', ], 'DeleteUserBackupFile' => [ 'summary' => 'Deletes the backup files of an ApsaraDB RDS for MySQL instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', ], 'parameters' => [ [ 'name' => 'BackupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the full backup file. You can call the ListUserBackupFiles operation to query the information about all full backup files in a region.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'b-w1haya7e4i25********', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the instance. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The resource group ID. You can call the DescribeDBInstanceAttribute operation to query the resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy*****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'BackupId' => [ 'description' => 'The ID of the deleted full backup file.'."\n", 'type' => 'string', 'example' => 'b-w1haya7e4i25********', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'F28AE40B-203B-4CFE-B81F-FD981CD97B17', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OperationDenied.Product', 'errorMessage' => 'The product code is not supported.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"BackupId\\": \\"b-w1haya7e4i25****\\",\\n \\"RequestId\\": \\"F28AE40B-203B-4CFE-B81F-FD981CD97B17\\"\\n}","errorExample":""},{"type":"xml","example":"\\n F28AE40B-203B-4CFE-B81F-FD981CD97B17\\n b-w1haya7e4i25********\\n","errorExample":""}]', 'title' => 'DeleteUserBackupFile', 'description' => '### [](#)Supported database engine'."\n" ."\n" .'* MySQL'."\n" ."\n" .'### [](#)Usage notes'."\n" ."\n" .'* A full backup file contains the data of a self-managed MySQL instance. You can restore the data of a self-managed MySQL instance from a full backup file to an ApsaraDB RDS for MySQL instance. For more information, see [Migrate the data of a self-managed MySQL 5.7 instance to the cloud](~~251779~~).'."\n" .'* This operation deletes full backup files only from the ApsaraDB RDS console. This operation does not affect the full backup files that are stored as objects in Object Storage Service (OSS) buckets. After you call this operation to delete a full backup file, you can call the ImportUserBackupFile operation to reimport the full backup file.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'UpdateUserBackupFile' => [ 'summary' => 'Modifies the description and retention period of a full backup file.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'BackupId', 'in' => 'query', 'schema' => [ 'description' => 'The backup ID. You can call the ListUserBackupFiles operation to query the backup ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'b-kwwvr7v8t7of********', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'Comment', 'in' => 'query', 'schema' => [ 'description' => 'The new description of the full backup file.'."\n", 'type' => 'string', 'required' => false, 'example' => 'CommentTest', 'maxLength' => 256, 'minLength' => 2, ], ], [ 'name' => 'Retention', 'in' => 'query', 'schema' => [ 'description' => 'The new retention period of the full backup file. Unit: days. Valid values: any non-zero positive integer.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The resource group ID. You can call the DescribeDBInstanceAttribute operation to query the resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy*****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'BackupId' => [ 'description' => 'The ID of the backup file.'."\n", 'type' => 'string', 'example' => 'b-g14d0m772f7b********', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '6A236067-4727-4B42-92CF-734E417ED69A', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'The specified parameter is invalid.', ], [ 'errorCode' => 'OperationDenied.Product', 'errorMessage' => 'The product code is not supported.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"BackupId\\": \\"b-lvn2365ev9f1****\\",\\n \\"RequestId\\": \\"29EBB093-DBD8-5EEB-841D-E611B88CDE4B\\"\\n}","type":"json"}]', 'title' => 'UpdateUserBackupFile', 'description' => '### Supported database engines'."\n" ."\n" .'RDS MySQL'."\n" ."\n" .'### References'."\n" ."\n" .'A full backup file contains the data of a self-managed MySQL database. You can restore the data of a self-managed MySQL database from a full backup file to an ApsaraDB RDS for MySQL instance. For more information, see [Migrate the data of a self-managed MySQL 5.7 or MySQL 8.0 instance to an ApsaraDB RDS for MySQL instance](~~251779~~).'."\n" ."\n" .'> : Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.'."\n", ], 'ListUserBackupFiles' => [ 'summary' => 'Queries the details about the full backup files that are imported into an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'The status of the full backup file. Valid values:'."\n" ."\n" .'* **Importing**: The full backup file is being imported.'."\n" .'* **Failed**: The full backup file fails to be imported.'."\n" .'* **CheckSucccess**: The full backup file passes the check.'."\n" .'* **BackupSuccess**: The full backup file is imported.'."\n" .'* **Deleted**: The full backup file is deleted.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'CheckSuccess', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'Comment', 'in' => 'query', 'schema' => [ 'description' => 'The description of the full backup file.'."\n" ."\n" .'> The system implements a fuzzy match based on the value of this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'BackupTest', ], ], [ 'name' => 'BackupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the full backup file.'."\n", 'type' => 'string', 'required' => false, 'example' => 'b-kwwvr7v8t7of********', ], ], [ 'name' => 'OssUrl', 'in' => 'query', 'schema' => [ 'description' => 'The URL from which you can download the full backup file that is stored as an object in an Object Storage Service (OSS) bucket. For more information about how to obtain the URL, see [Obtain the access URL after you upload objects](~~39607~~).'."\n", 'type' => 'string', 'required' => false, 'example' => 'https://******.oss-ap-********.aliyuncs.com/backup_qp.xb', ], ], [ 'name' => 'Tags', 'in' => 'query', 'schema' => [ 'description' => 'The tag that is added to the full backup file.'."\n", 'type' => 'string', 'required' => false, 'example' => 'key1:value1', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The resource group ID. You can call the DescribeDBInstanceAttribute operation to obtain the ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy*****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Records' => [ 'description' => 'The information about the full backup files.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'BackupId' => [ 'description' => 'The ID of the full backup file.'."\n", 'type' => 'string', 'example' => 'b-kwwvr7v8t7of********', ], 'BinlogInfo' => [ 'description' => 'The information about the binary log file that contains incremental data. If incremental data is generated during the full backup, this parameter is returned.'."\n", 'type' => 'string', 'example' => '{\\"binlogPosition\\":\\"154\\",\\"binlogFile\\":\\"0.000002\\"}', ], 'Comment' => [ 'description' => 'The description of the full backup file.'."\n", 'type' => 'string', 'example' => 'BackupTest', ], 'CreationTime' => [ 'description' => 'The time when the system started to import the full backup file. The value is a UNIX timestamp. Unit: milliseconds.'."\n", 'type' => 'string', 'example' => '1623231084000', ], 'Engine' => [ 'description' => 'The database engine of the instance.'."\n", 'type' => 'string', 'example' => 'mysql', ], 'EngineVersion' => [ 'description' => 'The database engine version.'."\n", 'type' => 'string', 'example' => '5.7', ], 'FinishTime' => [ 'description' => 'The time when the full backup file is successfully imported. The value is a UNIX timestamp. Unit: milliseconds.'."\n", 'type' => 'string', 'example' => '1623231750000', ], 'ModificationTime' => [ 'description' => 'The time when the full backup file is successfully imported. The value is a UNIX timestamp. Unit: milliseconds.'."\n", 'type' => 'string', 'example' => '1623231750000', ], 'OssBucket' => [ 'description' => 'The name of the OSS bucket in which the full backup file is stored as an object.'."\n", 'type' => 'string', 'example' => 'BackupTest', ], 'OssFileMetaData' => [ 'description' => 'The metadata of the full backup file. For more information, see [Manage object metadata](~~31859~~).'."\n", 'type' => 'string', 'example' => '{\\"Accept-Ranges\\":\\"bytes\\",\\"Connection\\":\\"keep-alive\\",\\"Content-Length\\":81014337,\\"Content-Type\\":\\"application/octet-stream\\",\\"Date\\":1623309548000,\\"ETag\\":\\"889FE9E5FCEBFE4781829488A352863B-1\\",\\"Last-Modified\\":1622186844000,\\"Server\\":\\"AliyunOSS\\",\\"x-oss-hash-crc64ecma\\":\\"5793608435727323129\\",\\"x-oss-object-type\\":\\"Multipart\\",\\"x-oss-request-id\\":\\"60C1BCEC92572F37318BD499\\",\\"x-oss-server-time\\":\\"166\\",\\"x-oss-storage-class\\":\\"Standard\\"}', ], 'OssFileName' => [ 'description' => 'The name of the full backup file that is stored as an object in an OSS bucket.'."\n", 'type' => 'string', 'example' => 'backup_qp.xb', ], 'OssFilePath' => [ 'description' => 'The path of the full backup file that is stored as an object in an OSS bucket.'."\n", 'type' => 'string', 'example' => 'test/backup_qp.xb', ], 'OssFileSize' => [ 'description' => 'The size of the full backup file that is stored as an object in an OSS bucket. Unit: KB.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '79115', ], 'OssUrl' => [ 'description' => 'The URL to download the full backup file from the OSS bucket.'."\n", 'type' => 'string', 'example' => 'https://******.oss-ap-********.aliyuncs.com/backup_qp.xb', ], 'Reason' => [ 'description' => 'The reason why the full backup file failed to be imported.'."\n", 'type' => 'string', 'example' => 'success', ], 'RestoreSize' => [ 'description' => 'The amount of storage that is required to restore the data of the full backup file. Unit: GB.'."\n", 'type' => 'string', 'example' => '20', ], 'Retention' => [ 'description' => 'The retention period of the full backup file. Unit: days.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'Status' => [ 'description' => 'The status of the full backup file. Valid values:'."\n" ."\n" .'* **Importing**: The full backup file is being imported.'."\n" .'* **Failed**: The full backup file fails to be imported.'."\n" .'* **CheckSucccess**: The full backup file passes the check.'."\n" .'* **BackupSuccess**: The full backup file is imported.'."\n" .'* **Deleted**: The full backup file is deleted.'."\n", 'type' => 'string', 'example' => 'BackupSuccess', ], 'ZoneId' => [ 'description' => 'The zone ID of the full backup file.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou-b', ], ], ], ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'AD67C22F-64F3-4448-A9A8-D1606D242879', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Records\\": [\\n {\\n \\"BackupId\\": \\"b-kwwvr7v8t7of****\\",\\n \\"BinlogInfo\\": \\"{\\\\\\\\\\\\\\"binlogPosition\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"154\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"binlogFile\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"0.000002\\\\\\\\\\\\\\"}\\",\\n \\"Comment\\": \\"BackupTest\\",\\n \\"CreationTime\\": \\"1623231084000\\",\\n \\"Engine\\": \\"mysql\\",\\n \\"EngineVersion\\": \\"5.7\\",\\n \\"FinishTime\\": \\"1623231750000\\",\\n \\"ModificationTime\\": \\"1623231750000\\",\\n \\"OssBucket\\": \\"BackupTest\\",\\n \\"OssFileMetaData\\": \\"{\\\\\\\\\\\\\\"Accept-Ranges\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"bytes\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Connection\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"keep-alive\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Content-Length\\\\\\\\\\\\\\":81014337,\\\\\\\\\\\\\\"Content-Type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"application/octet-stream\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Date\\\\\\\\\\\\\\":1623309548000,\\\\\\\\\\\\\\"ETag\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"889FE9E5FCEBFE4781829488A352863B-1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Last-Modified\\\\\\\\\\\\\\":1622186844000,\\\\\\\\\\\\\\"Server\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"AliyunOSS\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"x-oss-hash-crc64ecma\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"5793608435727323129\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"x-oss-object-type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Multipart\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"x-oss-request-id\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"60C1BCEC92572F37318BD499\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"x-oss-server-time\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"166\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"x-oss-storage-class\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Standard\\\\\\\\\\\\\\"}\\",\\n \\"OssFileName\\": \\"backup_qp.xb\\",\\n \\"OssFilePath\\": \\"test/backup_qp.xb\\",\\n \\"OssFileSize\\": 79115,\\n \\"OssUrl\\": \\"https://****.oss-ap-****.aliyuncs.com/backup_qp.xb\\",\\n \\"Reason\\": \\"success\\",\\n \\"RestoreSize\\": \\"20\\",\\n \\"Retention\\": 3,\\n \\"Status\\": \\"BackupSuccess\\",\\n \\"ZoneId\\": \\"cn-hangzhou-b\\"\\n }\\n ],\\n \\"RequestId\\": \\"AD67C22F-64F3-4448-A9A8-D1606D242879\\"\\n}","errorExample":""},{"type":"xml","example":"\\n9FB29A6E-C63A-4810-B71D-AFC65FD66309\\n\\n BackupSuccess\\n b-c8677aw89jo7********\\n 5.7\\n ghjtest\\n b-c8677aw89jo7********\\n 1623310685000\\n 3\\n {\\"Accept-Ranges\\":\\"bytes\\",\\"Connection\\":\\"keep-alive\\",\\"Content-Length\\":81014337,\\"Content-MD5\\":\\"WBKyX0RbaSVjiwINUgEuTA==\\",\\"Content-Type\\":\\"application/octet-stream\\",\\"Date\\":1623310682000,\\"ETag\\":\\"5812B25F445B6925638B020D52012E4C\\",\\"Last-Modified\\":1623310648000,\\"Server\\":\\"AliyunOSS\\",\\"x-oss-hash-crc64ecma\\":\\"5793608435727323129\\",\\"x-oss-object-type\\":\\"Normal\\",\\"x-oss-request-id\\":\\"60C1C15AA846BB3737811ED8\\",\\"x-oss-server-time\\":\\"17\\",\\"x-oss-storage-class\\":\\"Standard\\"}\\n 1623310685000\\n https://******.oss-ap-********.aliyuncs.com/backup_qp.xb\\n backup_qp.xb\\n 20\\n 79115\\n mysql\\n test/backup_qp.xb\\n\\n","errorExample":""}]', 'title' => 'ListUserBackupFiles', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" ."\n" .'### [](#)Feature description'."\n" ."\n" .'* A full backup file contains the data of a self-managed MySQL database. You can restore the data of a self-managed MySQL database from a full backup file to an ApsaraDB RDS for MySQL instance. For more information, see [Migrate the data of a self-managed MySQL 5.7 instance to the cloud](~~251779~~).'."\n" .'* Before you call the [CreateDBInstance](~~26228~~) operation to create an ApsaraDB RDS for MySQL instance into which you want to import full backup files, you can call this operation to query the IDs of full backup files.'."\n" .'* You can call the [ImportUserBackupFile](~~260266~~) operation to import a full backup file into an ApsaraDB RDS for MySQL instance.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ImportUserBackupFile' => [ 'summary' => 'Imports the backup data of a self-managed instance that runs MySQL 5.7 to an ApsaraDB RDS for MySQL instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the instance. You can call the DescribeRegions operation to query the most recent region list.'."\n" ."\n" .'> * The value of this parameter is the ID of the region in which you want to create the instance.'."\n" .'> * The value of this parameter must be consistent with the value of **BucketRegion**.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'Mode', 'in' => 'query', 'schema' => [ 'type' => 'string', 'example' => 'oss', 'default' => 'oss', 'enum' => [ 'oss', 'stream', ], ], ], [ 'name' => 'EngineVersion', 'in' => 'query', 'schema' => [ 'description' => 'The version of the database engine that is run on the self-managed MySQL database and ApsaraDB RDS for MySQL instance. Set the value to **5.7**.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '5.7', 'default' => '5.7', ], ], [ 'name' => 'BucketRegion', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the OSS bucket where the full backup file of the self-managed MySQL database is located. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'BackupFile', 'in' => 'query', 'schema' => [ 'description' => 'A JSON array that consists of the information about the full backup file stored as an object in an OSS bucket. Example: `{"Bucket":"test", "Object":"test/test_db_employees.xb","Location":"ap-southeast-1"}`'."\n" ."\n" .'The JSON array contains the following fields:'."\n" ."\n" .'* **Bucket**: The name of the OSS bucket in which the full backup file is stored as an object. You can call the [GetBucket](~~31965~~) operation to query the name of the bucket.'."\n" .'* **Object**: The path of the full backup file that is stored as an object in the OSS bucket. You can call the [GetObject](~~31980~~) operation to query the path of the object.'."\n" .'* **Location**: The ID of the region in which the OSS bucket is located. You can call the [GetBucketLocation](~~31967~~) operation to query the region of the bucket.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '{"Bucket":"test", "Object":"test/test_db_employees.xb","Location":"ap-southeast-1"}', ], ], [ 'name' => 'Comment', 'in' => 'query', 'schema' => [ 'description' => 'The description of the full backup file.'."\n", 'type' => 'string', 'required' => false, 'example' => 'BackupTest', 'maxLength' => 256, 'minLength' => 2, ], ], [ 'name' => 'RestoreSize', 'in' => 'query', 'schema' => [ 'description' => 'The amount of storage that is required to restore the data of the full backup file. Unit: GB.'."\n" ."\n" .'> * The default value of this parameter is 5 times the size of the full backup file.'."\n" .'> * The minimum value of this parameter is 20.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'Retention', 'in' => 'query', 'schema' => [ 'description' => 'The retention period of the full backup file. Unit: days. Valid values: any **non-zero** positive integer.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', ], ], [ 'name' => 'ZoneId', 'in' => 'query', 'schema' => [ 'description' => 'The zone ID. You can call the DescribeRegions operation to query the zone ID.'."\n" ."\n" .'> * If you specify this parameter, the system creates a snapshot in single-digit seconds, which greatly reduces the time that is required to import the full backup file.'."\n" .'> * When you call the CreateDBInstance operation to create an instance by using the full backup file, the instance is created in the zone that you specify for this parameter.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-b', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The resource group ID. You can call the DescribeDBInstanceAttribute operation to query the resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy****', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, 'description' => 'The instance ID.'."\n", 'example' => 'rm-uf6wjk5****', ], ], [ 'name' => 'SourceInfo', 'in' => 'query', 'schema' => [ 'type' => 'string', ], ], [ 'name' => 'BuildReplication', 'in' => 'query', 'schema' => [ 'type' => 'boolean', 'default' => 'false', ], ], [ 'name' => 'MasterInfo', 'in' => 'query', 'schema' => [ 'type' => 'string', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'BackupId' => [ 'description' => 'The ID of the full backup file.'."\n", 'type' => 'string', 'example' => 'b-n8tpg24c6i0v********', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'A140DD14-DCC9-4548-9C72-52A49A58A310', ], 'Status' => [ 'description' => 'Indicates whether the full backup file is successfully imported into the instance. If the full backup file is successfully imported, **true** is returned. Otherwise, an error message is returned.'."\n", 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidOssBackupFile.InvalidFile', 'errorMessage' => 'The specified OSS backup file is invalid.', ], [ 'errorCode' => 'OperationDenied.Product', 'errorMessage' => 'The product code is not supported.', ], [ 'errorCode' => 'InvalidBackupFile.Format', 'errorMessage' => 'The specified params BackupFile(BackupId or RestoreTime or BackupFile) is not valid.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'InvalidUserBakset', 'errorMessage' => 'The user backup set to be imported is invalid.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"BackupId\\": \\"b-n8tpg24c6i0v****\\",\\n \\"RequestId\\": \\"A140DD14-DCC9-4548-9C72-52A49A58A310\\",\\n \\"Status\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n A140DD14-DCC9-4548-9C72-52A49A58A310\\n b-n8tpg24c6i0v********\\n true\\n","errorExample":""}]', 'title' => 'ImportUserBackupFile', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" ."\n" .'### [](#)Description'."\n" ."\n" .'A full backup file contains the data of a self-managed MySQL instance. You can restore the data of a self-managed MySQL instance from a full backup file to an ApsaraDB RDS for MySQL instance.'."\n" ."\n" .'### [](#)Usage notes'."\n" ."\n" .'Before you call this operation, make sure that the following requirements are met:'."\n" ."\n" .'* The self-managed MySQL instance runs MySQL 5.7 and is backed up by using XtraBackup. The name of the backup file ends with `_qp.xb`. For more information, see [Migrate the data of a self-managed MySQL 5.7 instance to the cloud](~~251779~~).'."\n" .'* The full backup file of the self-managed MySQL instance is uploaded to an Object Storage Service (OSS) bucket in the region of the ApsaraDB RDS for MySQL instance. For more information, see [Migrate the data of a self-managed MySQL 5.7 instance to the cloud](~~251779~~).'."\n" ."\n" .'> This operation is supported only for MySQL 5.7.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'CreateMigrateTask' => [ 'summary' => 'Creates a migration task to restore backup files from an Object Storage Service (OSS) bucket to an ApsaraDB RDS for SQL Server instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk******', ], ], [ 'name' => 'DBName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the destination database.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'testDB', ], ], [ 'name' => 'BackupMode', 'in' => 'query', 'schema' => [ 'description' => 'The type of the migration task. Valid values:'."\n" ."\n" .'* **FULL**: The migration task migrates full backup files.'."\n" .'* **UPDF**: The migration task migrates incremental or log backup files.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'FULL', 'enum' => [ 'FULL', 'DIFF', 'UPDF', '0', '1', '2', ], ], ], [ 'name' => 'IsOnlineDB', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to make the restored database data available for user access. Valid values:'."\n" ."\n" .'* **True**'."\n" .'* **False**'."\n" ."\n" .'> Set the value to **True** for instances that run SQL Server 2008 R2.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'True', ], ], [ 'name' => 'CheckDBMode', 'in' => 'query', 'schema' => [ 'description' => 'The consistency check method for the database. Valid values:'."\n" ."\n" .'* **SyncExecuteDBCheck**: synchronous database check'."\n" .'* **AsyncExecuteDBCheck**: asynchronous database check'."\n" ."\n" .'Default value: **AsyncExecuteDBCheck** (compatible with SQL Server 2008 R2)'."\n" ."\n" .'> This parameter is valid when **IsOnlineDB** is set to **True**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'AsyncExecuteDBCheck', 'default' => '0', ], ], [ 'name' => 'OssObjectPositions', 'in' => 'query', 'schema' => [ 'description' => 'The information about the backup file in the OSS bucket. The values consist of three parts that are separated by colons (:):'."\n" ."\n" .'* OSS endpoint: oss-ap-southeast-1.aliyuncs.com.'."\n" .'* Name of the OSS bucket: rdsmssqlsingapore.'."\n" .'* Key of the backup file in the OSS bucket: autotest\\_2008R2\\_TestMigration_FULL.bak.'."\n" ."\n" .'> * This parameter is optional for instances that run SQL Server 2008 R2.'."\n" .'> * This parameter is required for instances that run a major engine version later than SQL Server 2008 R2.', 'type' => 'string', 'required' => false, 'example' => 'oss-ap-southeast-1.aliyuncs.com:rdsmssqlsingapore:autotest_2008R2_TestMigration_FULL.bak', ], ], [ 'name' => 'OSSUrls', 'in' => 'query', 'schema' => [ 'description' => 'The shared URL of the backup file in the OSS bucket. The URL must be encoded.'."\n" ."\n" .'If you specify multiple URLs, separate them with vertical bars (|) and then encode them.'."\n" ."\n" .'> This parameter is required for instances that run SQL Server 2008 R2.'."\n", 'type' => 'string', 'required' => false, 'example' => 'check_cdn_oss.sh www.xxxxxx.mobi ', ], ], [ 'name' => 'MigrateTaskId', 'in' => 'query', 'schema' => [ 'description' => 'The migration task ID.'."\n" ."\n" .'* If you set **BackupMode** to **FULL**, the value of this parameter is empty. The full backup mode is compatible with instance that runs SQL Server 2008 R2.'."\n" .'* If you set **BackupMode** to **UPDF**, the value of this parameter is the ID of the required full migration task.'."\n" ."\n" .'> * If you set **IsOnlineDB** to **True**, the value of **BackupMode** must be **FULL**.'."\n" .'> * If you set **IsOnlineDB** to **False**, the value of **BackupMode** must be **UPDF**.', 'type' => 'string', 'required' => false, 'example' => 'None'."\n", ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'BackupMode' => [ 'description' => 'The type of the migration task. Valid values:'."\n" ."\n" .'* **FULL**: The migration task migrates full backup files.'."\n" .'* **UPDF**: The migration task migrates incremental or log backup files.'."\n", 'type' => 'string', 'example' => 'FULL', ], 'DBInstanceId' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk******', ], 'DBName' => [ 'description' => 'The name of the database.'."\n", 'type' => 'string', 'example' => 'test02', ], 'MigrateTaskId' => [ 'description' => 'The ID of the migration task.'."\n", 'type' => 'string', 'example' => '564******', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '866F5EB8-4650-4061-87F0-379F6F968BCE', ], 'TaskId' => [ 'description' => 'The task ID.'."\n", 'type' => 'string', 'example' => '545****', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidFile', 'errorMessage' => 'The operation does not support this kind of file', ], [ 'errorCode' => 'InvalidInstanceType', 'errorMessage' => 'The DB instance type does not support this operation.', ], [ 'errorCode' => 'InvalidInstanceLockMode', 'errorMessage' => 'The DB instance lock mode does not support this operation.', ], [ 'errorCode' => 'InvalidDBName', 'errorMessage' => 'The instance does not have the specified DB name.', ], [ 'errorCode' => 'InvalidDBType', 'errorMessage' => 'The DB type does not support this operation.', ], [ 'errorCode' => 'InvalidDBState', 'errorMessage' => 'The DB state does not support this operation.', ], [ 'errorCode' => 'ExceedUploadTime', 'errorMessage' => 'Exceeding the daily upload times of this DB.', ], [ 'errorCode' => 'InvalidOSSURL', 'errorMessage' => 'The Specified OSS URL is not valid', ], [ 'errorCode' => 'ExceedDiskSize', 'errorMessage' => 'The file size exceeding the disk size', ], [ 'errorCode' => 'EntityNotExist.Role', 'errorMessage' => 'The role not exists', ], [ 'errorCode' => 'DatabaseMustOnline', 'errorMessage' => 'Database must be taken online when task type is 0 or 1.', ], [ 'errorCode' => 'InvalideStatus', 'errorMessage' => 'Parent migrate task status is invalid.', ], [ 'errorCode' => 'InvalidOssObjectStorageClassType', 'errorMessage' => 'The specified OSS bucket storage type is invalid.', ], [ 'errorCode' => 'EngineNotSupported', 'errorMessage' => 'Engine specified cannot be supported the operation.', ], [ 'errorCode' => 'EngineVersionNotSupported', 'errorMessage' => 'EngineVersion specified cannot be replicate with the source DB Instance.', ], [ 'errorCode' => 'BakFileSizeExceeded', 'errorMessage' => 'Exceeding the allowed backup file size.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'InvalidInstanceState', 'errorMessage' => 'The DB instance state does not support this operation.', ], [ 'errorCode' => 'InvalidOssObjectPositions.Format', 'errorMessage' => 'The specified params OssObjectPositions is not valid.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'BakFilesNeeded', 'errorMessage' => 'Backup file does not supply.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"BackupMode\\": \\"FULL\\",\\n \\"DBInstanceId\\": \\"rm-uf6wjk5****\\",\\n \\"DBName\\": \\"test02\\",\\n \\"MigrateTaskId\\": \\"564563****\\",\\n \\"RequestId\\": \\"866F5EB8-4650-4061-87F0-379F6F968BCE\\",\\n \\"TaskId\\": \\"545****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n\\t135847\\r\\n\\trm-bp178grbxxxxxxx\\r\\n\\t5F2B3757-BD56-40B3-B5F2-FCDD9FA0E2E2\\r\\n\\tUPDF\\r\\n\\t128301751\\r\\n\\ttest02\\r\\n\\r\\n\\t","errorExample":""}]', 'title' => 'CreateMigrateTask', 'description' => '### [](#)Supported database engine'."\n" ."\n" .'SQL Server'."\n" ."\n" .'### [](#)Limits'."\n" ."\n" .'Data migration across Alibaba Cloud accounts is not supported. For example, backup files in an Object Storage Service (OSS) bucket within Alibaba Cloud Account A cannot be migrated to an ApsaraDB RDS for SQL Server instance within Alibaba Cloud Account B.'."\n" ."\n" .'> You can migrate backup files from an OSS bucket within Alibaba Cloud Account A to an OSS bucket within Alibaba Cloud Account B. Make sure that the data in the OSS bucket and the RDS instance belong to the same Alibaba Cloud account. Then, you can call this operation to create a migration task. For more information, see [Use Data Online Migration to migrate data between accounts](~~342762~~).'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> Before you call this operation, carefully read the following topic. Make sure that you fully understand the prerequisites, preparations, and impacts for calling this operation.'."\n" ."\n" .'[Migrate data from a self-managed SQL Server instance to an ApsaraDB RDS for SQL Server instance](~~100019~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'CreateOnlineDatabaseTask' => [ 'summary' => 'Opens the database that is involved in a backup data migration task of an ApsaraDB RDS for SQL Server instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCz****', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5xxxxxxx', ], ], [ 'name' => 'DBName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'testDB', ], ], [ 'name' => 'MigrateTaskId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the migration task.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '5652255443', ], ], [ 'name' => 'CheckDBMode', 'in' => 'query', 'schema' => [ 'description' => 'The consistency check method after the database is open. Valid values:'."\n" ."\n" .'* **SyncExecuteDBCheck**: synchronous database check'."\n" .'* **AsyncExecuteDBCheck**: asynchronous database check'."\n" ."\n" .'> The check methods are supported for RDS instances that run SQL Server 2008 R2.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'AsyncExecuteDBCheck', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1B2EBD14-36F6-4645-A3F9-DE19D321C18F', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'EngineNotSupported', 'errorMessage' => 'Engine specified cannot be supported the operation.', ], [ 'errorCode' => 'EngineVersionNotSupported', 'errorMessage' => 'EngineVersion specified cannot be replicate with the source DB Instance.', ], [ 'errorCode' => 'InvalideStatus', 'errorMessage' => 'Parent migrate task status is invalid.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance engine and type does not support operations.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'Invalid DBInstanceId NotFound.', ], [ 'errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1B2EBD14-36F6-4645-A3F9-DE19D321C18F\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 1B2EBD14-36F6-4645-A3F9-DE19D321C18F\\n","errorExample":""}]', 'title' => 'CreateOnlineDatabaseTask', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* SQL Server'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> : Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.'."\n" ."\n" .'This operation is used to migrate backup data to the cloud. Before you call this operation, make sure that you understand the descriptions in the following topics:'."\n" ."\n" .'* [Migrate the full backup data of a self-managed SQL Server database to an ApsaraDB RDS instance that runs SQL Server 2008 R2](~~95737~~)'."\n" .'* [Migrate full backup data of SQL Server 2012, 2014, 2016, 2017, or 2019 databases](~~95738~~)'."\n" .'* [Migrate incremental backup data to ApsaraDB RDS for SQL Server 2012, 2014, 2016, 2017, or 2019](~~95736~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeMigrateTasks' => [ 'summary' => 'Queries the tasks that are created to migrate the backup data of an ApsaraDB RDS for SQL Server instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5xxxxxxx', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2017-10-20T01:00Z', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => 'The end of the time range to query. The end time must be later than the start time. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2017-10-25T01:00Z', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Valid values: **30** to **100**. Default value: **30**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '30', 'example' => '30', 'default' => '30', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => 'The page number. Valid values: any non-zero positive integer.'."\n" ."\n" .'Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'default' => '1', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy*****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'DBInstanceId' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5xxxxxxx', ], 'Items' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'MigrateTask' => [ 'description' => 'The details of the migration task.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'BackupMode' => [ 'description' => 'The migration task type. Valid values:'."\n" ."\n" .'* **FULL**: The migration task migrates full backup files that can be used to restore the full data of the instance.'."\n" .'* **UPDF**: The migration task migrates incremental or log backup files that can be used to restore the incremental data of the instance.'."\n", 'type' => 'string', 'example' => 'FULL', ], 'CreateTime' => [ 'description' => 'The time when the migration task was created. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2017-05-30T12:11:04Z', ], 'DBName' => [ 'description' => 'The database name.'."\n", 'type' => 'string', 'example' => 'testDB', ], 'Description' => [ 'description' => 'The description of the migration task.'."\n", 'type' => 'string', 'example' => 'Api description', ], 'EndTime' => [ 'description' => 'The time when the migration task was completed. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2017-05-30T13:11:04Z', ], 'IsDBReplaced' => [ 'description' => 'Indicates whether the imported data overwrites the existing data.'."\n", 'type' => 'string', 'example' => 'True', ], 'MigrateTaskId' => [ 'description' => 'The migration task ID.'."\n", 'type' => 'string', 'example' => '564522545', ], 'Status' => [ 'description' => 'The status of the migration task. Valid values:'."\n" ."\n" .'* **NoStart**: The task is not started.'."\n" .'* **Running**:The task is in progress.'."\n" .'* **Success**: The task is successful.'."\n" .'* **Failed**: The task failed.'."\n" .'* **Waiting**: The task is waiting for an incremental backup file to be imported.'."\n", 'type' => 'string', 'example' => 'Success', ], ], ], ], ], ], 'PageNumber' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageRecordCount' => [ 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '4E356DDF-6B83-45DB-99D5-4B1E8A0D286B', ], 'TotalRecordCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidStartTimeAndEndTime.Malformed', 'errorMessage' => 'The end time must be greater than the start time', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'InvalidInstanceState', 'errorMessage' => 'The DB instance state does not support this operation.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBInstanceId\\": \\"rm-uf6wjk5****\\",\\n \\"Items\\": {\\n \\"MigrateTask\\": [\\n {\\n \\"BackupMode\\": \\"FULL\\",\\n \\"CreateTime\\": \\"2017-05-30T12:11:04Z\\",\\n \\"DBName\\": \\"testDB\\",\\n \\"Description\\": \\"Api description\\",\\n \\"EndTime\\": \\"2017-05-30T13:11:04Z\\",\\n \\"IsDBReplaced\\": \\"True\\",\\n \\"MigrateTaskId\\": \\"564522545\\",\\n \\"Status\\": \\"Success\\"\\n }\\n ]\\n },\\n \\"PageNumber\\": 1,\\n \\"PageRecordCount\\": 10,\\n \\"RequestId\\": \\"4E356DDF-6B83-45DB-99D5-4B1E8A0D286B\\",\\n \\"TotalRecordCount\\": 30\\n}","errorExample":"{\\n \\"RequestId\\": \\"7463B73D-35CC-4D19-A010-6B8D65D242EF\\",\\n \\"HostId\\": \\"rds.aliyuncs.com\\",\\n \\"Code\\": \\"UnsupportedOperation\\",\\n \\"Message\\": \\"The specified action is not supported.\\"\\n}"},{"type":"xml","example":"\\n\\n\\tA5409D02-D661-4BF3-8F3D-0A814D0574E7\\n\\t1\\n\\t1\\n\\t10\\n\\t\\n\\t\\trm-bp1842vxxxxx\\n\\t\\ttest02\\n\\t\\t2017-05-30 T12:11:4Z\\n\\t\\t2017-05-30 T12:11:4Z\\n\\t\\tTrue\\n\\t\\tSuccess\\n\\t\\tFULL\\n\\t\\tApi description\\n\\t\\n\\n\\t\\n","errorExample":""}]', 'title' => 'DescribeMigrateTasks', 'description' => '### [](#)Supported database engine'."\n" ."\n" .'* SQL Server'."\n" ."\n" .'### [](#)Usage notes'."\n" ."\n" .'This operation allows you to query the migration tasks that are created for the instance over the last week.'."\n" ."\n" .'### [](#)Precautions'."\n" ."\n" .'* This operation is supported only for migration tasks that are created to migrate full backup files.'."\n" .'* This operation is not supported for instances that run SQL Server 2017 on RDS Cluster Edition.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeOssDownloads' => [ 'summary' => 'Queries the backup files that are included in a backup data migration task of an ApsaraDB RDS for SQL Server instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-uf6wjk5xxxxxxx', ], ], [ 'name' => 'MigrateTaskId', 'in' => 'query', 'schema' => [ 'description' => 'The migration task ID. You can call the DescribeMigrateTasks operation to query the migration task ID.'."\n", 'type' => 'string', 'required' => true, 'example' => '5625458541', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy*****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'DBInstanceId' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5xxxxxxx', ], 'Items' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'OssDownload' => [ 'description' => 'Details of the backup file.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'BackupMode' => [ 'description' => 'The backup type. Valid values:'."\n" ."\n" .'* **Database**: full backup file'."\n" .'* **Differential_Database**: incremental backup file'."\n" .'* **Transaction_Log**: log backup file'."\n", 'type' => 'string', 'example' => 'Database', ], 'CreateTime' => [ 'description' => 'The time when the backup file was created in the download list. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2017-08-17T12:45:15Z', ], 'Description' => [ 'description' => 'The description of the backup file.'."\n", 'type' => 'string', 'example' => 'App description', ], 'EndTime' => [ 'description' => 'The end of the time range during which data was queried. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2017-08-27T12:45:15Z', ], 'FileName' => [ 'description' => 'The name of the backup file stored in the Object Storage Service (OSS) bucket.'."\n", 'type' => 'string', 'example' => 'test', ], 'FileSize' => [ 'description' => 'The size of the backup file. Unit: MB'."\n", 'type' => 'string', 'example' => '2', ], 'IsAvailable' => [ 'description' => 'Indicates whether the backup file is available. Valid values: **True and False**.'."\n", 'type' => 'string', 'example' => 'True', ], 'Status' => [ 'description' => 'The state of the backup file. Valid values:'."\n" ."\n" .'* **NoStart**'."\n" .'* **Downloading**'."\n" .'* **Finished**'."\n" .'* **DownloadFailed**'."\n" .'* **VerifyFailed**'."\n" .'* **Deleted**'."\n" .'* **DeleteFailed**'."\n" .'* **CheckSuccess**'."\n" .'* **CheckFailed**'."\n" .'* **Restoring**'."\n" .'* **Restored**'."\n" .'* **RestoreFailed**'."\n", 'type' => 'string', 'example' => 'Finished', ], ], ], ], ], ], 'MigrateTaskId' => [ 'description' => 'The ID of the migration task.'."\n", 'type' => 'string', 'example' => '562154852', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'A5409D02-D661-4BF3-8F3D-0A814D0574E7', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBInstanceId\\": \\"rm-uf6wjk5****\\",\\n \\"Items\\": {\\n \\"OssDownload\\": [\\n {\\n \\"BackupMode\\": \\"Database\\",\\n \\"CreateTime\\": \\"2017-08-17T12:45:15Z\\",\\n \\"Description\\": \\"App description\\",\\n \\"EndTime\\": \\"2017-08-27T12:45:15Z\\",\\n \\"FileName\\": \\"test\\",\\n \\"FileSize\\": \\"2\\",\\n \\"IsAvailable\\": \\"True\\",\\n \\"Status\\": \\"Finished\\"\\n }\\n ]\\n },\\n \\"MigrateTaskId\\": \\"562154852\\",\\n \\"RequestId\\": \\"A5409D02-D661-4BF3-8F3D-0A814D0574E7\\"\\n}","errorExample":""},{"type":"xml","example":"\\n A5409D02-D661-4BF3-8F3D-0A814D0574E7\\n rm-uf6wjk5xxxxxxx\\n 562154852\\n \\n \\n Finished\\n App description\\n 2017-08-27T12:45:15Z\\n True\\n Database\\n 2017-08-17T12:45:15Z\\n test\\n 2\\n \\n \\n","errorExample":""}]', 'title' => 'DescribeOssDownloads', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* SQL Server'."\n" ."\n" .'### [Usage notes](#)'."\n" ."\n" .'This operation is not supported for instances that run SQL Server 2017 EE or SQL Server 2019 EE.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeMigrateTaskById' => [ 'summary' => 'Queries a task that is used to import the backup data of an ApsaraDB RDS for SQL Server instance to an Object Storage Service (OSS) bucket.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-bp11e1tzgxxxx4ox', ], ], [ 'name' => 'MigrateTaskId', 'in' => 'query', 'schema' => [ 'description' => 'The migration task ID. You can call the DescribeMigrateTasks operation to query the migration task ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '235943', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy*****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'BackupMode' => [ 'description' => 'The type of the migration task. Valid values:'."\n" ."\n" .'* **FULL**: The migration task migrates full backup files that can be used to restore the full data of the instance.'."\n" .'* **UPDF**: The migration task migrates incremental or log backup files that can be used to restore the incremental data of the instance.'."\n", 'type' => 'string', 'example' => 'FULL', ], 'CreateTime' => [ 'description' => 'The time when the migration task was created. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2020-05-30T12:11:04Z', ], 'DBInstanceName' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5xxxxxxxxxx', ], 'DBName' => [ 'description' => 'The name of the database.'."\n", 'type' => 'string', 'example' => 'mytestdb', ], 'Description' => [ 'description' => 'The description of the migration task.'."\n", 'type' => 'string', 'example' => 'Success to DBCC checkdb asynchronously', ], 'EndTime' => [ 'description' => 'The time when the migration task was completed. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2021-05-30T15:15:05Z', ], 'IsDBReplaced' => [ 'description' => 'Indicates whether the imported data overwrites the existing data. Valid values:'."\n" ."\n" .'* **False**: The imported data does not overwrite the existing data.'."\n" .'* **True**: The imported data overwrites the existing data.'."\n", 'type' => 'string', 'example' => 'False', ], 'MigrateTaskId' => [ 'description' => 'The ID of the migration task.'."\n", 'type' => 'string', 'example' => '235943', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '6ED3635A-01F9-47BD-B9C8-CB3FD70A336E', ], 'Status' => [ 'description' => 'The status of the migration task. Valid values:'."\n" ."\n" .'* **NoStart**: The task has not started.'."\n" .'* **Running**:The task is in progress.'."\n" .'* **Success**: The task is successful.'."\n" .'* **Failed**: The task failed.'."\n" .'* **Waiting**: The task is waiting for an incremental backup file to be imported.'."\n", 'type' => 'string', 'example' => 'Success', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidStartTimeAndEndTime.Malformed', 'errorMessage' => 'The end time must be greater than the start time.', ], [ 'errorCode' => 'InvalidMigrateTask', 'errorMessage' => 'The specified MigrateTaskId 237360 does not exist. Please check again.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'InvalidInstanceState', 'errorMessage' => 'The DB instance state does not support this operation.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"BackupMode\\": \\"FULL\\",\\n \\"CreateTime\\": \\"2020-05-30T12:11:04Z\\",\\n \\"DBInstanceName\\": \\"rm-uf6wjk5****\\",\\n \\"DBName\\": \\"mytestdb\\",\\n \\"Description\\": \\"Success to DBCC checkdb asynchronously\\",\\n \\"EndTime\\": \\"2021-05-30T15:15:05Z\\",\\n \\"IsDBReplaced\\": \\"False\\",\\n \\"MigrateTaskId\\": \\"235943\\",\\n \\"RequestId\\": \\"6ED3635A-01F9-47BD-B9C8-CB3FD70A336E\\",\\n \\"Status\\": \\"Success\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n Success\\r\\n Success to DBCC checkdb asynchronously\\r\\n B994DF29-44A1-43FD-A693-917930DFEBCE\\r\\n 2021-03-04T13:50:23Z\\r\\n 235943\\r\\n 2021-03-04T13:47:17Z\\r\\n FULL\\r\\n mytestdb\\r\\n rm-bp11e1tzgxxxxx4ox\\r\\n","errorExample":""}]', 'title' => 'DescribeMigrateTaskById', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* SQL Server'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'TerminateMigrateTask' => [ 'summary' => 'Terminates an ongoing migration task of an ApsaraDB RDS for SQL Server instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-bp159vfbu******', ], ], [ 'name' => 'MigrateTaskId', 'in' => 'query', 'schema' => [ 'description' => 'The migration task ID. You can call the DescribeMigrateTasks operation to query the migration task ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '56254****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidTaskType.Invalid', 'errorMessage' => 'Migrate task type Incremental is not supported, only support FULL backup migrate task.', ], [ 'errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', ], [ 'errorCode' => 'InvalidTask.NotFound', 'errorMessage' => 'Specified MigrateTaskId could not be found on RDS.', ], [ 'errorCode' => 'InvalidParameter.Invalid', 'errorMessage' => 'Specified MigrateTaskId is invalid.', ], [ 'errorCode' => 'InvalidTaskStatus', 'errorMessage' => 'Current task status (Terminated/Failed) does not support.', ], [ 'errorCode' => 'UnfinishedTerminateMigrateTask', 'errorMessage' => 'Specified MigrateTaskId terminate failed.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 1AD222E9-E606-4A42-BF6D-8A4442913CEF\\r\\n","errorExample":""}]', 'title' => 'TerminateMigrateTask', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* SQL Server'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DeleteADSetting' => [ 'summary' => 'Deletes an ApsaraDB RDS for SQL Server instance from an Active Directory (AD) domain.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCz*****', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-bp1k8s41l2o52****', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the region.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'EngineNotSupported', 'errorMessage' => 'The engine does not support the operation.', ], [ 'errorCode' => 'EngineVersionNotSupported', 'errorMessage' => 'EngineVersion specified cannot be replicate with the source DB Instance.', ], [ 'errorCode' => 'InvalidInstanceNodeType.NotFound', 'errorMessage' => 'The specified NodeType is not found.', ], [ 'errorCode' => 'InvalidShareDbInstanceClassNotSupport', 'errorMessage' => 'The current instance classType is not support operation.', ], [ 'errorCode' => 'IncorrectEngineVersion', 'errorMessage' => 'Current DB instance engine version does not support this operation.', ], [ 'errorCode' => 'InvalidADDNS.NotFound', 'errorMessage' => 'Specified ADDNS is null.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'InvalidOperation.Invalid', 'errorMessage' => 'Current instance is not in Domain, remove operation is only valid when current instance is in domain.', ], [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', ], [ 'errorCode' => 'ClusterTypeError', 'errorMessage' => 'Custins Cluster Type Error, Support User Cluster', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'Invalid DBInstanceId NotFound.', ], [ 'errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'Specified instance does not exist or not support.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 1AD222E9-E606-4A42-BF6D-8A4442913CEF\\n","errorExample":""}]', 'title' => 'DeleteADSetting', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* SQL Server'."\n", ], 'ModifyADInfo' => [ 'summary' => 'Modifies the AD domain information about an ApsaraDB RDS for SQL Server instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxx', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5xxxxxxx', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'ADDNS', 'in' => 'query', 'schema' => [ 'description' => 'The DNS information about the AD domain.'."\n", 'type' => 'string', 'required' => false, 'example' => 'example.com', ], ], [ 'name' => 'ADServerIpAddress', 'in' => 'query', 'schema' => [ 'description' => 'The IP address of the AD domain.'."\n", 'type' => 'string', 'required' => false, 'example' => '47.100.XX.XX', ], ], [ 'name' => 'ADAccountName', 'in' => 'query', 'schema' => [ 'description' => 'The account of the AD domain.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test_account', ], ], [ 'name' => 'ADPassword', 'in' => 'query', 'schema' => [ 'description' => 'The password for the account of the AD domain.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test_password', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'EngineVersionNotSupported', 'errorMessage' => 'The current engineVersion does not support AD operation.', ], [ 'errorCode' => 'InvalidADDNS.NotFound', 'errorMessage' => 'Specified adDNS is null.', ], [ 'errorCode' => 'InvalidAdServerIpAddress.NotFound', 'errorMessage' => 'Specified adServer IpAddress is null.', ], [ 'errorCode' => 'InvalidAdAccountName.NotFound', 'errorMessage' => 'Specified adAccountName is null.', ], [ 'errorCode' => 'InvalidAdPassword.NotFound', 'errorMessage' => 'Specified adPassword is null.', ], [ 'errorCode' => 'InvalidShareDbInstanceClassNotSupport', 'errorMessage' => 'The current instance classType does not support this operation.', ], [ 'errorCode' => 'InvalidNodeType.NotSupport', 'errorMessage' => 'The specified nodeType does not support.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], [ 'errorCode' => 'ClusterTypeNotSupported', 'errorMessage' => 'The current Instance ClusterType does not support this operation.', ], [ 'errorCode' => 'InvalidAdUserName', 'errorMessage' => 'Invalid user name for ad domain.', ], [ 'errorCode' => 'InvalidAdIp', 'errorMessage' => 'The ip address of the ad domain is invalid.', ], [ 'errorCode' => 'InvalidAdDomain', 'errorMessage' => 'The name of the ad domain is invalid.', ], [ 'errorCode' => 'InvalidOperation.Remove', 'errorMessage' => 'Current instance is not in Domain, remove operation is only valid when current instance is in domain.', ], [ 'errorCode' => 'InvalidOperation.Add', 'errorMessage' => 'Current instance is already in Domain, if you want join another domain, please remove first.', ], [ 'errorCode' => 'InvalidAdPassword', 'errorMessage' => 'Invalid password for ad domain.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 1AD222E9-E606-4A42-BF6D-8A4442913CEF\\n","errorExample":""}]', 'title' => 'ModifyADInfo', 'description' => '### [](#)Supported database engine'."\n" ."\n" .'* SQL Server'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> Before you call this operation, read the following documentation and make sure that you fully understand the prerequisites and impacts of this operation.'."\n" ."\n" .'* [Connect an RDS instance to a self-managed domain](~~170734~~)'."\n", ], 'DescribeADInfo' => [ 'summary' => 'Queries information about the AD domain of an instance. The information includes whether the instance is added to the AD domain, the name of the AD domain, and the account.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the generated token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCz*****', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-bp1k8s41l2o52****', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'ADDNS' => [ 'description' => 'The DNS information about the AD domain.'."\n", 'type' => 'string', 'example' => '100.100.XX.XX', ], 'ADServerIpAddress' => [ 'description' => 'The service IP address of the AD domain.'."\n", 'type' => 'string', 'example' => '192.168.XX.XX', ], 'ADStatus' => [ 'description' => 'The status of the AD domain. Valid values:'."\n" ."\n" .'* **-1**: The instance is being added to the AD domain.'."\n" .'* **0**: The instance fails to be added to the AD domain.'."\n" .'* **1**: The instance is added to the AD domain.'."\n", 'type' => 'string', 'example' => '1', ], 'AbnormalReason' => [ 'description' => 'The cause of the error.'."\n", 'type' => 'string', 'example' => 'XXXX', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', ], 'UserName' => [ 'description' => 'The username of the AD domain.'."\n", 'type' => 'string', 'example' => 'test_01', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"ADDNS\\": \\"100.100.XX.XX\\",\\n \\"ADServerIpAddress\\": \\"192.168.XX.XX\\",\\n \\"ADStatus\\": \\"1\\",\\n \\"AbnormalReason\\": \\"****\\",\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"UserName\\": \\"test_01\\"\\n}","errorExample":""},{"type":"xml","example":"\\n DA62101F-9710-506F-B9A4-DD89C432B04B\\n","errorExample":""}]', 'title' => 'DescribeADInfo', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* SQL Server'."\n", ], 'CreateCloudMigrationPrecheckTask' => [ 'summary' => 'Creates an assessment task for cloud migration to an ApsaraDB RDS for PostgreSQL instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', ], 'parameters' => [ [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pgm-bp102g323jd4****', ], ], [ 'name' => 'SourceIpAddress', 'in' => 'query', 'schema' => [ 'description' => 'The private IP address that is used to connect to the self-managed PostgreSQL instance.'."\n" ."\n" .'* If the self-managed PostgreSQL instance resides on an ECS instance, enter the private IP address of the ECS instance. For more information about how to obtain the private IP address of an ECS instance, see [View IP addresses](~~273914~~).'."\n" .'* If the self-managed PostgreSQL instance resides in an on-premises data center, enter the private IP address of the on-premises data center.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '172.2.XX.XX', ], ], [ 'name' => 'SourcePort', 'in' => 'query', 'schema' => [ 'description' => 'The port that is used to connect to the self-managed PostgreSQL instance. You can run the `netstat -a | grep PGSQL` command to view the port.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '5432', ], ], [ 'name' => 'SourceAccount', 'in' => 'query', 'schema' => [ 'description' => 'The username of the account that is used to connect to the self-managed PostgreSQL instance. Enter the username of the account that you created in the [Create an account for cloud migration on a self-managed PostgreSQL instance](~~369500~~) topic.'."\n", 'type' => 'string', 'required' => true, 'example' => 'migratetest', ], ], [ 'name' => 'SourcePassword', 'in' => 'query', 'schema' => [ 'description' => 'The password of the account that is used to connect to the self-managed PostgreSQL instance. Enter the password of the account that you created in the [Create an account for cloud migration on a self-managed PostgreSQL instance](~~369500~~) topic.'."\n", 'type' => 'string', 'required' => true, 'example' => '123456', ], ], [ 'name' => 'TaskName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the task. If you do not specify this parameter, ApsaraDB RDS automatically generates a name for the cloud migration task.'."\n", 'type' => 'string', 'required' => false, 'example' => 'slf7w7wj3g', ], ], [ 'name' => 'SourceCategory', 'in' => 'query', 'schema' => [ 'description' => 'The environment in which the self-managed PostgreSQL instance runs.'."\n" ."\n" .'* **idcOnVpc**: The self-managed PostgreSQL instance resides in a data center. The data center can communicate with the VPC to which the ApsaraDB RDS for PostgreSQL instance belongs.'."\n" .'* **ecsOnVpc**: The self-managed PostgreSQL instance resides on an ECS instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ecsOnVpc', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'DBInstanceName' => [ 'description' => 'The name of the instance.'."\n", 'type' => 'string', 'example' => 'pgm-bp102g323jd4****', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '60F9A12A-16B8-4728-B099-4CA38D32C31C', ], 'TaskId' => [ 'description' => 'The ID of the task.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '439946016', ], 'TaskName' => [ 'description' => 'The name of the task.'."\n", 'type' => 'string', 'example' => 'slf7w7wj3g', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'The current instance state does not support this operation.', ], [ 'errorCode' => 'InvalidSourceCategory', 'errorMessage' => 'specified source category is invalid.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'IncorrectDBInstance', 'errorMessage' => 'The current DB instance does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'The database instance type does not support the operation.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', ], [ 'errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBInstanceName\\": \\"pgm-bp102g323jd4****\\",\\n \\"RequestId\\": \\"60F9A12A-16B8-4728-B099-4CA38D32C31C\\",\\n \\"TaskId\\": 439946016,\\n \\"TaskName\\": \\"slf7w7wj3g\\"\\n}","errorExample":""},{"type":"xml","example":"\\n pgm-bp102g323jd4****\\n 60F9A12A-16B8-4728-B099-4CA38D32C31C\\n 439946016\\n slf7w7wj3g\\n","errorExample":""}]', 'title' => 'CreateCloudMigrationPrecheckTask', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* PostgreSQL'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.'."\n" ."\n" .'[Use the cloud migration feature](~~365562~~)'."\n", ], 'CreateCloudMigrationTask' => [ 'summary' => 'Creates a cloud migration task for an ApsaraDB RDS for PostgreSQL instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', ], 'parameters' => [ [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the destination instance. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pgm-bp102g323jd4****', ], ], [ 'name' => 'SourceIpAddress', 'in' => 'query', 'schema' => [ 'description' => 'The private or public IP address that is used to connect to the self-managed PostgreSQL instance.'."\n" ."\n" .'* If the self-managed PostgreSQL instance resides on an Elastic Compute Service (ECS) instance, enter the private IP address of the ECS instance. For more information about how to obtain the private IP address of an ECS instance, see [View IP addresses](~~273914~~).'."\n" .'* If the self-managed PostgreSQL instance resides in a data center, enter the private IP address of the data center.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '172.16.XX.XX', ], ], [ 'name' => 'SourcePort', 'in' => 'query', 'schema' => [ 'description' => 'The port number that is used to connect to the self-managed PostgreSQL instance. You can run the `netstat -a | grep PGSQL` command to obtain the port number.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '5432', ], ], [ 'name' => 'SourceAccount', 'in' => 'query', 'schema' => [ 'description' => 'The username of the account that is used to connect to the self-managed PostgreSQL instance. Enter the username of the account that you created in the [Create an account for cloud migration on a self-managed PostgreSQL instance](~~369500~~) topic.'."\n", 'type' => 'string', 'required' => true, 'example' => 'migratetest', ], ], [ 'name' => 'SourcePassword', 'in' => 'query', 'schema' => [ 'description' => 'The password of the account that is used to connect to the self-managed PostgreSQL instance. Enter the password of the account that you created in the [Create an account for cloud migration on a self-managed PostgreSQL instance](~~369500~~) topic.'."\n", 'type' => 'string', 'required' => true, 'example' => '123456', ], ], [ 'name' => 'TaskName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the task. If you do not specify this parameter, ApsaraDB RDS automatically generates a name for the cloud migration task.'."\n", 'type' => 'string', 'required' => false, 'example' => '362c6c7a-4d20-4eac-898c-1495ceab374c', ], ], [ 'name' => 'SourceCategory', 'in' => 'query', 'schema' => [ 'description' => 'The environment in which the self-managed PostgreSQL instance runs.'."\n" ."\n" .'* **idcOnVpc**: The self-managed PostgreSQL instance resides in a data center. The data center can communicate with the VPC to which the ApsaraDB RDS for PostgreSQL instance belongs.'."\n" .'* **ecsOnVpc**: The self-managed PostgreSQL instance resides on an ECS instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ecsOnVpc', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'DBInstanceName' => [ 'description' => 'The name of the instance.'."\n", 'type' => 'string', 'example' => 'pgm-bp102g323jd4****', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '8B993DA9-5272-5414-94E3-4CA8BA0146C2', ], 'TaskId' => [ 'description' => 'The ID of the task.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '440437220', ], 'TaskName' => [ 'description' => 'The name of the task.'."\n", 'type' => 'string', 'example' => '362c6c7a-4d20-4eac-898c-1495ceab374c', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'The current instance state does not support this operation.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'IncorrectDBInstance', 'errorMessage' => 'The current DB instance does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'The database instance type does not support the operation.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', ], [ 'errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBInstanceName\\": \\"pgm-bp102g323jd4****\\",\\n \\"RequestId\\": \\"8B993DA9-5272-5414-94E3-4CA8BA0146C2\\",\\n \\"TaskId\\": 440437220,\\n \\"TaskName\\": \\"362c6c7a-4d20-4eac-898c-1495ceab374c\\"\\n}","errorExample":""},{"type":"xml","example":"\\n pgm-bp102g323jd4****\\n 8B993DA9-5272-5414-94E3-4CA8BA0146C2\\n 440437220\\n 362c6c7a-4d20-4eac-898c-1495ceab374c\\n","errorExample":""}]', 'title' => 'CreateCloudMigrationTask', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* PostgreSQL'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> : Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.'."\n" ."\n" .'[Use the cloud migration feature](~~365562~~)'."\n", ], 'DescribeCloudMigrationPrecheckResult' => [ 'summary' => 'Query the details about the assessment report for cloud migration to an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pgm-bp102g323jd4****', ], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'description' => 'The task ID. You can obtain the task ID from the response that is returned after you call the CreateCloudMigrationPrecheckTask operation to create the task.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '439946016', ], ], [ 'name' => 'TaskName', 'in' => 'query', 'schema' => [ 'description' => 'The task name. You can obtain the task name from the response that is returned after you call the CreateCloudMigrationPrecheckTask operation to create the task.'."\n", 'type' => 'string', 'required' => false, 'example' => 'slf7w7wj3g', ], ], [ 'name' => 'SourceIpAddress', 'in' => 'query', 'schema' => [ 'description' => 'The private or public IP address that is used to connect to the self-managed PostgreSQL instance.'."\n" ."\n" .'* If the self-managed PostgreSQL instance resides on an Elastic Compute Service (ECS) instance, enter the private IP address of the ECS instance. For more information about how to obtain the private IP address of an ECS instance, see [View IP addresses](~~273914~~).'."\n" .'* If the self-managed PostgreSQL instance resides in an on-premises data center, enter the private IP address of the on-premises data center.'."\n", 'type' => 'string', 'required' => false, 'example' => '172.2.XX.XX', ], ], [ 'name' => 'SourcePort', 'in' => 'query', 'schema' => [ 'description' => 'The port number that is used to connect to the self-managed PostgreSQL instance. You can run the netstat -a | grep PGSQL command to obtain the port number.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '5432', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page. Valid values: **30** to **100**. Default value: 30.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => 'The page number. Pages start from page 1. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Items' => [ 'description' => 'The details about the assessment report.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Detail' => [ 'description' => 'The content of the assessment report.'."\n", 'type' => 'string', 'example' => '[Check rds empty]\\nCheck rds databases: success\\n[Check source connectivity]\\nCheck ip connectable: success\\nCheck port connectable: success\\nCheck database connectable: success\\nCheck account replication privilege: success\\nCheck account createrole privilege: success\\nCheck account monitor privilege: success\\n[Check source version]\\nCheck major version consistent: success\\n[Check source glibc version]\\nCheck source glibc version compatible: warning(warning:source glibc version is not compatible with rds pg)\\n[Check disk size]\\nCheck disk size enough: success\\n[Check wal keep size]\\nCheck wal keep size large enough: success\\n[Check spec params]\\nCheck if spec params too large: success\\n [Check triggers]\\nCheck triggers compatible: success\\n[Check user functions]\\nCheck user functions compatible: success\\n*Migrate check success*', ], 'GmtCreated' => [ 'description' => 'The time when the task was created.'."\n", 'type' => 'string', 'example' => '2022-02-25T06:57:41Z', ], 'GmtModified' => [ 'description' => 'The time when the task was modified.'."\n", 'type' => 'string', 'example' => '2022-02-25T06:58:00Z', ], 'SourceAccount' => [ 'description' => 'The username.'."\n", 'type' => 'string', 'example' => 'migratetest', ], 'SourceCategory' => [ 'description' => 'The environment in which the self-managed PostgreSQL instance runs.'."\n" ."\n" .'* **idcOnVpc**: The self-managed PostgreSQL instance resides in a data center. The data center can communicate with the VPC to which the ApsaraDB RDS for PostgreSQL instance belongs.'."\n" .'* **ecsOnVpc**: The self-managed PostgreSQL instance resides on an ECS instance.'."\n", 'type' => 'string', 'example' => 'ecsonvpc', ], 'SourceIpAddress' => [ 'description' => 'The private IP address that is used to connect to the self-managed PostgreSQL instance.'."\n", 'type' => 'string', 'example' => '172.2.XX.XX', ], 'SourcePassword' => [ 'description' => 'The password.'."\n", 'type' => 'string', 'example' => '123456', ], 'SourcePort' => [ 'description' => 'The port number that is used to connect to the self-managed PostgreSQL instance.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '5432', ], 'TargetEip' => [ 'description' => 'A reserved parameter. The return value of this parameter is empty.'."\n", 'type' => 'string', 'example' => 'null', ], 'TargetInstanceName' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'pgm-bp102g323jd4****', ], 'TaskId' => [ 'description' => 'The task ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '440420798', ], 'TaskName' => [ 'description' => 'The task name.'."\n", 'type' => 'string', 'example' => 'lxbv6rtxno8', ], ], ], ], 'PageNumber' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '7E4A6E1B-789B-5F16-9736-39AA57FC7374', ], 'TotalSize' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Items\\": [\\n {\\n \\"Detail\\": \\"[Check rds empty]\\\\\\\\nCheck rds databases: success\\\\\\\\n[Check source connectivity]\\\\\\\\nCheck ip connectable: success\\\\\\\\nCheck port connectable: success\\\\\\\\nCheck database connectable: success\\\\\\\\nCheck account replication privilege: success\\\\\\\\nCheck account createrole privilege: success\\\\\\\\nCheck account monitor privilege: success\\\\\\\\n[Check source version]\\\\\\\\nCheck major version consistent: success\\\\\\\\n[Check source glibc version]\\\\\\\\nCheck source glibc version compatible: warning(warning:source glibc version is not compatible with rds pg)\\\\\\\\n[Check disk size]\\\\\\\\nCheck disk size enough: success\\\\\\\\n[Check wal keep size]\\\\\\\\nCheck wal keep size large enough: success\\\\\\\\n[Check spec params]\\\\\\\\nCheck if spec params too large: success\\\\\\\\n [Check triggers]\\\\\\\\nCheck triggers compatible: success\\\\\\\\n[Check user functions]\\\\\\\\nCheck user functions compatible: success\\\\\\\\n*Migrate check success*\\",\\n \\"GmtCreated\\": \\"2022-02-25T06:57:41Z\\",\\n \\"GmtModified\\": \\"2022-02-25T06:58:00Z\\",\\n \\"SourceAccount\\": \\"migratetest\\",\\n \\"SourceCategory\\": \\"ecsonvpc\\",\\n \\"SourceIpAddress\\": \\"172.2.XX.XX\\",\\n \\"SourcePassword\\": \\"123456\\",\\n \\"SourcePort\\": 5432,\\n \\"TargetEip\\": \\"null\\",\\n \\"TargetInstanceName\\": \\"pgm-bp102g323jd4****\\",\\n \\"TaskId\\": 440420798,\\n \\"TaskName\\": \\"lxbv6rtxno8\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"7E4A6E1B-789B-5F16-9736-39AA57FC7374\\",\\n \\"TotalSize\\": 1\\n}","errorExample":""},{"type":"xml","example":"\\n 1\\n 7E4A6E1B-789B-5F16-9736-39AA57FC7374\\n \\n 2022-02-25T06:57:41Z\\n 2022-02-25T06:58:00Z\\n 440420798\\n lxbv6rtxno8\\n ecsonvpc\\n 172.2.XX.XX\\n 5432\\n migratetest\\n 123456\\n pgm-bp102g323jd4****\\n [Check rds empty]\\\\nCheck rds databases: success\\\\n[Check source connectivity]\\\\nCheck ip connectable: success\\\\nCheck port connectable: success\\\\nCheck database connectable: success\\\\nCheck account replication privilege: success\\\\nCheck account createrole privilege: success\\\\nCheck account monitor privilege: success\\\\n[Check source version]\\\\nCheck major version consistent: success\\\\n[Check source glibc version]\\\\nCheck source glibc version compatible: warning(warning:source glibc version is not compatible with rds pg)\\\\n[Check disk size]\\\\nCheck disk size enough: success\\\\n[Check wal keep size]\\\\nCheck wal keep size large enough: success\\\\n[Check spec params]\\\\nCheck if spec params too large: success\\\\n [Check triggers]\\\\nCheck triggers compatible: success\\\\n[Check user functions]\\\\nCheck user functions compatible: success\\\\n*Migrate check success*\\n \\n 1\\n 10\\n","errorExample":""}]', 'title' => 'DescribeCloudMigrationPrecheckResult', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* PostgreSQL'."\n", ], 'DescribeCloudMigrationResult' => [ 'summary' => 'Queries the details about the cloud migration task of an ApsaraDB RDS for PostgreSQL instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pgm-bp102g323jd4****', ], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'description' => 'The task ID. You can obtain the task ID from the response that is returned when you call the CreateCloudMigrationTask operation to create the task.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '440437220', ], ], [ 'name' => 'TaskName', 'in' => 'query', 'schema' => [ 'description' => 'The task name. You can obtain the task name from the response that is returned when you call the CreateCloudMigrationTask operation to create the task.'."\n", 'type' => 'string', 'required' => false, 'example' => '362c6c7a-4d20-4eac-898c-1495ceab374c', ], ], [ 'name' => 'SourceIpAddress', 'in' => 'query', 'schema' => [ 'description' => 'The private IP address that is used to connect to the self-managed PostgreSQL instance.'."\n" ."\n" .'* If the self-managed PostgreSQL instance resides on an Elastic Compute Service (ECS) instance, enter the private IP address of the ECS instance. For more information about how to obtain the private IP address of an ECS instance, see [View IP addresses](~~273914~~).'."\n" .'* If the self-managed PostgreSQL instance resides in a data center, enter the private IP address of the data center.'."\n", 'type' => 'string', 'required' => false, 'example' => '172.16.XX.XX', ], ], [ 'name' => 'SourcePort', 'in' => 'query', 'schema' => [ 'description' => 'The port number that is used to connect to the self-managed PostgreSQL instance. You can run the netstat -a | grep PGSQL command to obtain the port number.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '5432', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Items' => [ 'description' => 'The details about the cloud migration task.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Detail' => [ 'description' => 'The details about the migration task.'."\n", 'type' => 'string', 'example' => '[Check rds empty]\\nCheck rds databases: success\\n[Check source connectivity]\\nCheck ip connectable: success\\nCheck port connectable: success\\nCheck database connectable: success\\nCheck account replication privilege: success\\nCheck account createrole privilege: success\\nCheck account monitor privilege: success\\n[Check source version]\\nCheck major version consistent: success\\n[Check source glibc version]\\nCheck source glibc version compatible: warning(warning:source glibc version is not compatible with rds pg)\\n[Check disk size]\\nCheck disk size enough: success\\n[Check wal keep size]\\nCheck wal keep size large enough: success\\n[Check spec params]\\nCheck if spec params too large: success\\n[Start RDS instance]\\n2022-02-25 17:00:29 --- Start RDS instance as slave for data replication\\n[Synchronize data]\\n2022-02-25 17:01:05 --- Synchronize data from source to RDS by streaming replication \\n', ], 'GmtCreated' => [ 'description' => 'The time when the task was created.'."\n", 'type' => 'string', 'example' => '2022-02-25T08:53:13Z', ], 'GmtModified' => [ 'description' => 'The time when the task was modified.'."\n", 'type' => 'string', 'example' => '2022-03-01T06:39:51Z', ], 'MigrateStage' => [ 'description' => 'The migration phase of the migration task.'."\n" ."\n" .'* **precheck**: precheck'."\n" .'* **basebackup**: full data backup'."\n" .'* **startup**: link establishment'."\n" .'* **increment**: incremental data synchronization'."\n" .'* **switch**: cloud migration-triggered switchover'."\n" .'* **success**: cloud migration completed'."\n", 'type' => 'string', 'example' => 'switch', ], 'ReplicationInfo' => [ 'description' => 'The information about the replication link.'."\n", 'type' => 'string', 'example' => '{\\"Status\\":\\"streaming\\",\\"ReceiveStartLsn\\":\\"0/3000000\\",\\"ReceivedTli\\":\\"1\\",\\"LatestEndTime\\":\\"2022-02-25 17:03:59.3344+08\\",\\"Synced\\":\\"true\\",\\"IsSlave\\":\\"true\\",\\"ReplayTimestamp\\":\\"null\\",\\"LastMsgSendTime\\":\\"2022-03-01 14:42:57.967537+08\\",\\"Conninfo\\":\\"user=migratetest password=******** channel_binding=prefer dbname=replication host=172.16.254.203 port=5432 application_name=rds_db_instance fallback_application_name=walreceiver sslmode=prefer sslcompression=1 sslsni=1 ssl_min_protocol_version=TLSv1.2 gssencmode=prefer krbsrvname=postgres target_session_attrs=any\\",\\"LastMsgReceiptTime\\":\\"2022-03-01 14:42:57.96727+08\\",\\"LatestEndLsn\\":\\"0/3000148\\",\\"ReceivedLsn\\":\\"0/3000148\\",\\"ReplayLsn\\":\\"0/3000148\\",\\"ReceiveStartTli\\":\\"1\\",\\"ReplayLag\\":\\"0\\"}', ], 'ReplicationState' => [ 'description' => 'The status of data replication.'."\n" ."\n" .'* **unstarted**'."\n" .'* **catchup**'."\n" .'* **streaming**'."\n" .'* **disconnect**'."\n" .'* **finish**'."\n", 'type' => 'string', 'example' => 'streaming', ], 'SourceAccount' => [ 'description' => 'The username.'."\n", 'type' => 'string', 'example' => 'migratetest', ], 'SourceCategory' => [ 'description' => 'The environment in which the self-managed PostgreSQL instance runs.'."\n" ."\n" .'* **idcOnVpc**: The self-managed PostgreSQL instance resides in a data center. The data center can communicate with the VPC to which the ApsaraDB RDS for PostgreSQL instance belongs.'."\n" .'* **ecsOnVpc**: The self-managed PostgreSQL instance resides on an ECS instance.'."\n", 'type' => 'string', 'example' => 'ecsonvpc', ], 'SourceIpAddress' => [ 'description' => 'The private IP address that is used to connect to the self-managed PostgreSQL instance.'."\n", 'type' => 'string', 'example' => '172.16.XX.XX', ], 'SourcePassword' => [ 'description' => 'The password.'."\n", 'type' => 'string', 'example' => '123456', ], 'SourcePort' => [ 'description' => 'The port number that is used to connect to the self-managed PostgreSQL instance.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '5432', ], 'SwitchTime' => [ 'description' => 'The time when the switchover was performed.'."\n", 'type' => 'string', 'example' => '2022-03-01T06:40:51Z', ], 'TargetEip' => [ 'description' => 'A reserved parameter. The return value of this parameter is empty.'."\n", 'type' => 'string', 'example' => 'null', ], 'TargetInstanceName' => [ 'description' => 'The ID of the destination instance.'."\n", 'type' => 'string', 'example' => 'pgm-bp102g323jd4****', ], 'TaskId' => [ 'description' => 'The task ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '440437220', ], 'TaskName' => [ 'description' => 'The task name.'."\n", 'type' => 'string', 'example' => '362c6c7a-4d20-4eac-898c-1495ceab374c', ], ], ], ], 'PageNumber' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1B983C48-9793-5EAA-8F7F-00EAEC517675', ], 'TotalSize' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Items\\": [\\n {\\n \\"Detail\\": \\"[Check rds empty]\\\\\\\\nCheck rds databases: success\\\\\\\\n[Check source connectivity]\\\\\\\\nCheck ip connectable: success\\\\\\\\nCheck port connectable: success\\\\\\\\nCheck database connectable: success\\\\\\\\nCheck account replication privilege: success\\\\\\\\nCheck account createrole privilege: success\\\\\\\\nCheck account monitor privilege: success\\\\\\\\n[Check source version]\\\\\\\\nCheck major version consistent: success\\\\\\\\n[Check source glibc version]\\\\\\\\nCheck source glibc version compatible: warning(warning:source glibc version is not compatible with rds pg)\\\\\\\\n[Check disk size]\\\\\\\\nCheck disk size enough: success\\\\\\\\n[Check wal keep size]\\\\\\\\nCheck wal keep size large enough: success\\\\\\\\n[Check spec params]\\\\\\\\nCheck if spec params too large: success\\\\\\\\n[Start RDS instance]\\\\\\\\n2022-02-25 17:00:29 --- Start RDS instance as slave for data replication\\\\\\\\n[Synchronize data]\\\\\\\\n2022-02-25 17:01:05 --- Synchronize data from source to RDS by streaming replication \\\\\\\\n\\",\\n \\"GmtCreated\\": \\"2022-02-25T08:53:13Z\\",\\n \\"GmtModified\\": \\"2022-03-01T06:39:51Z\\",\\n \\"MigrateStage\\": \\"switch\\",\\n \\"ReplicationInfo\\": \\"{\\\\\\\\\\\\\\"Status\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"streaming\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ReceiveStartLsn\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"0/3000000\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ReceivedTli\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"LatestEndTime\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"2022-02-25 17:03:59.3344+08\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Synced\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"true\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"IsSlave\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"true\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ReplayTimestamp\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"null\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"LastMsgSendTime\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"2022-03-01 14:42:57.967537+08\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Conninfo\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"user=migratetest password=******** channel_binding=prefer dbname=replication host=172.16.254.203 port=5432 application_name=rds_db_instance fallback_application_name=walreceiver sslmode=prefer sslcompression=1 sslsni=1 ssl_min_protocol_version=TLSv1.2 gssencmode=prefer krbsrvname=postgres target_session_attrs=any\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"LastMsgReceiptTime\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"2022-03-01 14:42:57.96727+08\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"LatestEndLsn\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"0/3000148\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ReceivedLsn\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"0/3000148\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ReplayLsn\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"0/3000148\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ReceiveStartTli\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ReplayLag\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"0\\\\\\\\\\\\\\"}\\",\\n \\"ReplicationState\\": \\"streaming\\",\\n \\"SourceAccount\\": \\"migratetest\\",\\n \\"SourceCategory\\": \\"ecsonvpc\\",\\n \\"SourceIpAddress\\": \\"172.16.XX.XX\\",\\n \\"SourcePassword\\": \\"123456\\",\\n \\"SourcePort\\": 5432,\\n \\"SwitchTime\\": \\"2022-03-01T06:40:51Z\\",\\n \\"TargetEip\\": \\"null\\",\\n \\"TargetInstanceName\\": \\"pgm-bp102g323jd4****\\",\\n \\"TaskId\\": 440437220,\\n \\"TaskName\\": \\"362c6c7a-4d20-4eac-898c-1495ceab374c\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"1B983C48-9793-5EAA-8F7F-00EAEC517675\\",\\n \\"TotalSize\\": 1\\n}","errorExample":""},{"type":"xml","example":"\\n 1\\n 1B983C48-9793-5EAA-8F7F-00EAEC517675\\n \\n 2022-02-25T08:53:13Z\\n 2022-03-01T06:39:51Z\\n 440437220\\n 362c6c7a-4d20-4eac-898c-1495ceab374c\\n increment\\n ecsonvpc\\n 172.16.XX.XX\\n 5432\\n migratetest\\n 123456\\n null\\n pgm-bp102g323jd4****\\n streaming\\n {\\\\\\"Status\\\\\\":\\\\\\"streaming\\\\\\",\\\\\\"ReceiveStartLsn\\\\\\":\\\\\\"0/3000000\\\\\\",\\\\\\"ReceivedTli\\\\\\":\\\\\\"1\\\\\\",\\\\\\"LatestEndTime\\\\\\":\\\\\\"2022-02-25 17:03:59.3344+08\\\\\\",\\\\\\"Synced\\\\\\":\\\\\\"true\\\\\\",\\\\\\"IsSlave\\\\\\":\\\\\\"true\\\\\\",\\\\\\"ReplayTimestamp\\\\\\":\\\\\\"null\\\\\\",\\\\\\"LastMsgSendTime\\\\\\":\\\\\\"2022-03-01 14:42:57.967537+08\\\\\\",\\\\\\"Conninfo\\\\\\":\\\\\\"user=migratetest password=******** channel_binding=prefer dbname=replication host=172.16.254.203 port=5432 application_name=rds_db_instance fallback_application_name=walreceiver sslmode=prefer sslcompression=1 sslsni=1 ssl_min_protocol_version=TLSv1.2 gssencmode=prefer krbsrvname=postgres target_session_attrs=any\\\\\\",\\\\\\"LastMsgReceiptTime\\\\\\":\\\\\\"2022-03-01 14:42:57.96727+08\\\\\\",\\\\\\"LatestEndLsn\\\\\\":\\\\\\"0/3000148\\\\\\",\\\\\\"ReceivedLsn\\\\\\":\\\\\\"0/3000148\\\\\\",\\\\\\"ReplayLsn\\\\\\":\\\\\\"0/3000148\\\\\\",\\\\\\"ReceiveStartTli\\\\\\":\\\\\\"1\\\\\\",\\\\\\"ReplayLag\\\\\\":\\\\\\"0\\\\\\"}\\n [Check rds empty]\\\\nCheck rds databases: success\\\\n[Check source connectivity]\\\\nCheck ip connectable: success\\\\nCheck port connectable: success\\\\nCheck database connectable: success\\\\nCheck account replication privilege: success\\\\nCheck account createrole privilege: success\\\\nCheck account monitor privilege: success\\\\n[Check source version]\\\\nCheck major version consistent: success\\\\n[Check source glibc version]\\\\nCheck source glibc version compatible: warning(warning:source glibc version is not compatible with rds pg)\\\\n[Check disk size]\\\\nCheck disk size enough: success\\\\n[Check wal keep size]\\\\nCheck wal keep size large enough: success\\\\n[Check spec params]\\\\nCheck if spec params too large: success\\\\n[Start RDS instance]\\\\n2022-02-25 17:00:29 --- Start RDS instance as slave for data replication\\\\n[Synchronize data]\\\\n2022-02-25 17:01:05 --- Synchronize data from source to RDS by streaming replication \\\\n\\n 2022-03-01T06:40:51Z\\n \\n 1\\n 10\\n","errorExample":""}]', 'title' => 'DescribeCloudMigrationResult', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* PostgreSQL'."\n", ], 'ActivateMigrationTargetInstance' => [ 'summary' => 'Switches workloads over from the source PostgreSQL instance to the destination ApsaraDB RDS for PostgreSQL instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pgm-bp102g323jd4****', ], ], [ 'name' => 'SwitchTime', 'in' => 'query', 'schema' => [ 'description' => 'A reserved parameter. This parameter does not take effect.'."\n", 'type' => 'string', 'required' => false, 'example' => '2022-02-25T06:57:41Z', ], ], [ 'name' => 'SwitchTimeMode', 'in' => 'query', 'schema' => [ 'description' => 'The time when you want to perform the switchover.'."\n" ."\n" .'Set the value to 0. The value 0 specifies an immediate switchover.'."\n", 'type' => 'string', 'required' => false, 'example' => '0', ], ], [ 'name' => 'ForceSwitch', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to forcefully perform a switchover. Set the value to 1. The value 1 specifies a forceful switchover.'."\n", 'type' => 'string', 'required' => false, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'DBInstanceName' => [ 'description' => 'The name of the destination instance.'."\n", 'type' => 'string', 'example' => 'pgm-bp102g323jd4****', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '76364A52-E0AB-5CC8-9818-CF1DC482C092', ], 'SourceIpAddress' => [ 'description' => 'The private IP address that is used to connect to the self-managed PostgreSQL instance.'."\n", 'type' => 'string', 'example' => '172.16.XX.XX', ], 'SourcePort' => [ 'description' => 'The port number that is used to connect to the self-managed PostgreSQL instance.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '5432', ], 'TaskId' => [ 'description' => 'The ID of the identification task.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '440913675', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'The current instance state does not support this operation.', ], [ 'errorCode' => 'InvalidMigrateStatus', 'errorMessage' => 'The migrate target instance is not synced with source instance.', ], [ 'errorCode' => 'InvalidMigrateTask', 'errorMessage' => 'No running migrate task found.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'IncorrectDBInstance', 'errorMessage' => 'The current DB instance does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'The database instance type does not support the operation.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', ], [ 'errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBInstanceName\\": \\"pgm-bp102g323jd4****\\",\\n \\"RequestId\\": \\"76364A52-E0AB-5CC8-9818-CF1DC482C092\\",\\n \\"SourceIpAddress\\": \\"172.16.XX.XX\\",\\n \\"SourcePort\\": 5432,\\n \\"TaskId\\": 440913675\\n}","errorExample":""},{"type":"xml","example":"\\n pgm-bp102g323jd4****\\n 76364A52-E0AB-5CC8-9818-CF1DC482C092\\n 440913675\\n 172.16.XX.XX\\n 5432\\n","errorExample":""}]', 'title' => 'ActivateMigrationTargetInstance', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* PostgreSQL'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> : Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.'."\n" ."\n" .'[Use the cloud migration feature](~~365562~~)'."\n", ], 'CreateGADInstance' => [ 'summary' => 'Creates an ApsaraDB RDS global active database cluster.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', ], 'parameters' => [ [ 'name' => 'CentralRegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the central node. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'CentralDBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the primary instance. You can call the DescribeDBInstances operation to query the instance ID. The primary instance serves as the central node of the global active database cluster.'."\n" ."\n" .'> * A primary instance can serve only as the central node of a single global active database cluster.'."\n" .'> * The primary instance can serve as the central node of the global active database cluster only in the following regions: China (Hangzhou), China (Shanghai), China (Qingdao), China (Beijing), China (Zhangjiakou), China (Shenzhen), and China (Chengdu).', 'type' => 'string', 'required' => true, 'example' => 'rm-uf6wjk5*******', ], ], [ 'name' => 'DBList', 'in' => 'query', 'schema' => [ 'description' => 'A JSON array that consists of the information about a specified database on the central node. All database information that you specify in this array is synchronized to the unit nodes of the global active database cluster. The JSON array contains the following fields:'."\n" ."\n" .'* **name**: the name of the database.'."\n" .'* **all**: specifies whether to synchronize all data in the database or the table. Valid values: **true** and **false**.'."\n" .'* **Table**: the name of the table. If you set the **all** field to **false**, you must nest the name of the table that you want to synchronize into the JSON array.'."\n" ."\n" .'Example: `{ "testdb": { "name": "testdb", "all": false, "Table": { "order": { "name": "order", "all": true }, "ordernew": { "name": "ordernew", "all": true } } } }`'."\n", 'type' => 'string', 'required' => true, 'example' => '{ "testdb": { "name": "testdb", "all": false, "Table": { "order": { "name": "order", "all": true }, "ordernew": { "name": "ordernew", "all": true } } } }', ], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => [ 'description' => 'The name of the global active database cluster.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', ], ], [ 'name' => 'UnitNode', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The information about the unit node.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details about the unit node.'."\n", 'type' => 'object', 'properties' => [ 'DBInstanceDescription' => [ 'description' => 'The name of the unit node that you want to create. The name must meet the following requirements:'."\n" ."\n" .'* The name must be **2 to 255** characters in length.'."\n" .'* The name can contain letters, digits, underscores (\\_), and hyphens (-) and must start with a letter.'."\n" .'* Does not start with `http://` or `https://`.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', ], 'DBInstanceStorage' => [ 'description' => 'The storage capacity of the unit node that you want to create. Unit: GB. You can adjust the storage capacity in increments of 5 GB. For more information, see [Primary ApsaraDB RDS instance types](~~26312~~). You can also call the DescribeAvailableResource operation to query the storage capacity range that is supported by the new instance type.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', ], 'DBInstanceStorageType' => [ 'description' => 'The storage type of the new instance. Valid values:'."\n" ."\n" .'* **local_ssd**: Premium Local SSD (recommended)'."\n" .'* **cloud_ssd**: standard SSD. This storage type is not recommended. Standard SSDs are no longer available for purchase in specific Alibaba Cloud regions.'."\n" .'* **cloud_essd**: Enterprise SSD (ESSD) of performance level 1 (PL1).'."\n" .'* **cloud_essd2**: ESSD of PL2.'."\n" .'* **cloud_essd3**: ESSD of PL3.'."\n" ."\n" .'The default value of this parameter is determined by the instance type specified by the **DBInstanceClass** parameter.'."\n" ."\n" .'* If the instance type specifies the Premium Local SSD storage type, the default value of this parameter is **local_ssd**.'."\n" .'* If the instance type specifies the cloud disk storage type, the default value of this parameter is **cloud_essd**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cloud_essd2', ], 'DbInstanceClass' => [ 'description' => 'The instance type of the unit node that you want to create. For more information, see [Primary ApsaraDB RDS instance types](~~26312~~). You can call the DescribeAvailableResource operation to query the available instance types in a region.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rds.mysql.t1.small', ], 'DtsConflict' => [ 'description' => 'The conflict resolution policy based on which Data Transmission Service (DTS) responds to primary key conflicts during data synchronization to the unit node that you want to create. Valid values:'."\n" ."\n" .'* **overwrite**: DTS overwrites the conflicting primary key on the destination node.'."\n" .'* **interrupt**: DTS stops the synchronization task, reports an error, and then exits.'."\n" .'* **ignore**: DTS hides the conflicting primary key on the node.'."\n", 'type' => 'string', 'required' => true, 'example' => 'overwrite', ], 'DtsInstanceClass' => [ 'description' => 'The specifications of the data synchronization task for the unit node that you want to create. Valid values:'."\n" ."\n" .'* **small**'."\n" .'* **medium**'."\n" .'* **large**'."\n" .'* **micro**'."\n" ."\n" .'> For more information, see [Specifications of data synchronization tasks](~~26605~~).'."\n", 'type' => 'string', 'required' => true, 'example' => 'medium', ], 'Engine' => [ 'description' => 'The database engine of the unit node that you want to create. Set the value to **MySQL**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'MySQL', ], 'EngineVersion' => [ 'description' => 'The database engine version of the unit node that you want to create. Valid values:'."\n" ."\n" .'* **8.0**'."\n" .'* **5.7**'."\n" .'* **5.6**'."\n" .'* **5.5**'."\n", 'type' => 'string', 'required' => false, 'example' => '8.0', ], 'PayType' => [ 'description' => 'The billing method of the unit node that you want to create. Valid values:'."\n" ."\n" .'* **Postpaid**: pay-as-you-go'."\n" .'* **Prepaid**: subscription'."\n" ."\n" .'> The system automatically generates a purchase order and completes the payment. You do not need to manually confirm the purchase order or complete the payment.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Postpaid', ], 'RegionID' => [ 'description' => 'The region ID of the unit node that you want to create. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'maxItems' => 10, ], 'SecurityIPList' => [ 'description' => 'The [IP address whitelist](~~43185~~) of the unit node that you want to create. If you want to add more than one entry to the IP address whitelist, separate the entries with commas (,). Each entry must be unique. The IP address whitelist can contain up to 1,000 entries. The entries in the IP address whitelist must be in one of the following formats:'."\n" ."\n" .'* IP addresses, such as `10.10.10.10`.'."\n" .'* CIDR blocks, such as `10.10.10.10/24`. In this example, **24** indicates that the prefix of the IP address in the whitelist is 24 bits in length. You can replace 24 with a value within the range of **1 to 32**.'."\n", 'type' => 'string', 'required' => false, 'example' => '10.10.10.10', ], 'VSwitchID' => [ 'description' => 'The vSwitch ID of the unit node that you want to create.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vsw-bp1tg609m5j85********', ], 'VpcID' => [ 'description' => 'The virtual private cloud (VPC) ID of the unit node that you want to create.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vpc-bp19ame5m1r3o********', ], 'ZoneID' => [ 'description' => 'The zone ID of the unit node that you want to create. You can call the DescribeRegions operation to query the zone ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-h', ], 'ZoneIDSlave1' => [ 'description' => 'The zone ID of the secondary node of the unit node that you want to create. You can call the DescribeRegions operation to query the zone ID.'."\n" ."\n" .'* If the value of this parameter is the same as the **zone ID** of the unit node that you want to create, the single-zone deployment method is used.'."\n" .'* If the value of this parameter is different from the **zone ID** of the unit node that you want to create, the multiple-zone deployment method is used.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-h', ], 'ZoneIDSlave2' => [ 'description' => 'The zone ID of the logger node of the unit node that you want to create. You can call the DescribeRegions operation to query the zone ID.'."\n" ."\n" .'* If the value of this parameter is the same as the **zone ID** of the unit node that you want to create, the single-zone deployment method is used.'."\n" .'* If the value of this parameter is different from the **zone ID** of the unit node that you want to create, the multiple-zone deployment method is used.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-h', ], ], 'required' => false, ], 'required' => true, 'maxItems' => 10, 'minItems' => 1, ], ], [ 'name' => 'CentralRdsDtsAdminAccount', 'in' => 'query', 'schema' => [ 'description' => 'The username of the privileged account of the central node. You can call the DescribeAccounts operation to query the privileged account of the central node.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test', ], ], [ 'name' => 'CentralRdsDtsAdminPassword', 'in' => 'query', 'schema' => [ 'description' => 'The password of the privileged account of the central node.'."\n", 'type' => 'string', 'required' => true, 'example' => 'Test12345', ], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'An array that consists of the details about the tag.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details about the tag.'."\n", 'type' => 'object', 'properties' => [ 'Key' => [ 'description' => 'The key of the tag. You can create N tag keys at a time. Valid values of N: **1 to 20**. The value of this parameter cannot be an empty string.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testkey1', ], 'Value' => [ 'description' => 'The value of the tag. You can create N tag values at a time. Valid values of N: **1 to 20**. The value of this parameter can be an empty string.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testvalue1', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 20, 'minItems' => 1, ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy*****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '9F8C06AD-3F37-57A0-ABBF-ABD7824F55CE', ], 'Result' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'CreateMemberCount' => [ 'description' => 'The number of unit nodes that are created by calling this operation.'."\n", 'type' => 'string', 'example' => '2', ], 'GadInstanceName' => [ 'description' => 'The ID of the global active database cluster.'."\n", 'type' => 'string', 'example' => 'gad-rm-bp1npi2j8********', ], 'TaskID' => [ 'description' => 'The task ID.'."\n", 'type' => 'string', 'example' => '5374xxxx', ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'CreateGlobalActiveDatabase.GadInstanceNotActive', 'errorMessage' => 'gad instance not in active ', ], [ 'errorCode' => 'CreateGlobalActiveDatabaseFailed.CentralNodeNotSupportGAD', 'errorMessage' => 'CentralNode DB not support GAD', ], [ 'errorCode' => 'CreateGlobalActiveDatabaseFailed.UnitMemberParamsEmpty', 'errorMessage' => 'UnitMemberParams not valid', ], [ 'errorCode' => 'CreateGlobalActiveDatabaseFailed.UnitMemberParamsError', 'errorMessage' => 'UnitMemberParams not valid', ], [ 'errorCode' => 'CreateGlobalActiveDatabaseFailed.GadNameNotMatchCentralNode', 'errorMessage' => 'the gadInstanceName not match with the central node', ], [ 'errorCode' => 'CreateGlobalActiveDatabaseFailed.GadInstanceExists', 'errorMessage' => 'gad instance has exists,please add member!', ], [ 'errorCode' => 'CreateGlobalActiveDatabaseFailed.GadInstanceNotExists', 'errorMessage' => 'gad instance not exists,please create GAD!', ], [ 'errorCode' => 'CreateGlobalActiveDatabase.GadInstanceNotFound', 'errorMessage' => 'gad instance not Found', ], [ 'errorCode' => 'CreateGlobalActiveDatabase.GetInstanceMemberFaied', 'errorMessage' => 'get instance member list failed', ], [ 'errorCode' => 'CreateGlobalActiveDatabaseImpl.preCheckGadInstance', 'errorMessage' => 'exceed max member count 10', ], [ 'errorCode' => 'CreateGlobalActiveDatabaseImpl.preCheckMemberParams', 'errorMessage' => 'centralNode not exists', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9F8C06AD-3F37-57A0-ABBF-ABD7824F55CE\\",\\n \\"Result\\": {\\n \\"CreateMemberCount\\": \\"2\\",\\n \\"GadInstanceName\\": \\"gad-rm-bp1npi2j8****\\",\\n \\"TaskID\\": \\"5374****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n9F8C06AD-3F37-57A0-ABBF-ABD7824F55CE\\n\\n gad-rm-bp1npi2j8********\\n 1\\n\\n","errorExample":""}]', 'title' => 'CreateGADInstance', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'CreateGadInstanceMember' => [ 'summary' => 'Adds nodes to an ApsaraDB RDS global active database cluster.', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', ], 'parameters' => [ [ 'name' => 'CentralRegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the central node. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'CentralDBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the central node . You can call the DescribeGadInstances operation to query the ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gad-rm-bp1npi2j8****', ], ], [ 'name' => 'GadInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the global active database cluster. You can call the DescribeGadInstances operation to query the ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gad-rm-bp1npi2j8****', ], ], [ 'name' => 'UnitNode', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The information about the unit node.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'DBInstanceDescription' => [ 'description' => 'The name of the unit node that you want to create. The name must meet the following requirements:'."\n" ."\n" .'* The name must be **2 to 255** characters in length.'."\n" .'* The name can contain letters, digits, underscores (\\_), and hyphens (-) and must start with a letter.'."\n" .'* The name cannot start with `http://` or `https://`.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', ], 'DBInstanceStorage' => [ 'description' => 'The storage capacity of the unit node that you want to create. Unit: GB The storage capacity increases in increments of 5 GB. For more information, see [Primary ApsaraDB RDS instance types](~~26312~~). You can also call the DescribeAvailableResource operation to query the storage capacity range that is supported by the new instance type.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', ], 'DBInstanceStorageType' => [ 'description' => 'The storage type of the instance. Valid values:'."\n" ."\n" .'* **local_ssd**: local SSD'."\n" .'* **cloud_ssd**: standard SSD'."\n" .'* **cloud_essd**: PL1 ESSD'."\n" .'* **cloud_essd2**: PL2 ESSD'."\n" .'* **cloud_essd3**: PL3 ESSD'."\n", 'type' => 'string', 'required' => false, 'example' => 'cloud_essd', ], 'DbInstanceClass' => [ 'description' => 'The instance type of the unit node that you want to create. For more information, see [Primary ApsaraDB RDS instance types](~~26312~~). You can call the DescribeAvailableResource operation to query the available instance types in a region.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rds.mysql.t1.small', ], 'DtsConflict' => [ 'description' => 'The conflict resolution policy based on which Data Transmission Service (DTS) responds to primary key conflicts during data synchronization to the unit node that you want to create. Valid values:'."\n" ."\n" .'* **overwrite**: DTS overwrites the conflicting primary key on the destination node.'."\n" .'* **interrupt**: DTS stops the synchronization task, reports an error, and then exits.'."\n" .'* **ignore**: DTS overwrites the conflicting primary key on the logger node.'."\n", 'type' => 'string', 'required' => true, 'example' => 'overwrite', ], 'DtsInstanceClass' => [ 'description' => 'The specifications of the data synchronization task for the unit node that you want to create. Valid values:'."\n" ."\n" .'* **small**'."\n" .'* **medium**'."\n" .'* **large**'."\n" .'* **micro**'."\n" ."\n" .'> For more information, see [Specifications of data synchronization tasks](~~26605~~).'."\n", 'type' => 'string', 'required' => true, 'example' => 'medium', ], 'Engine' => [ 'description' => 'The database engine of the unit node that you want to create. Set the value to **MySQL**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'MySQL', ], 'EngineVersion' => [ 'description' => 'The database engine version of the unit node that you want to create. Valid values:'."\n" ."\n" .'* **8.0**'."\n" .'* **5.7**'."\n" .'* **5.6**'."\n" .'* **5.5**'."\n", 'type' => 'string', 'required' => false, 'example' => '8.0', ], 'RegionID' => [ 'description' => 'The region ID of the unit node or secondary node that you want to create. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], 'SecurityIPList' => [ 'description' => 'The [IP address whitelist](~~43185~~) of the unit node that you want to create. If you want to add more than one entry to the IP address whitelist, separate the entries with commas (,). Each entry must be unique. The IP address whitelist can contain up to 1,000 entries. The entries in the IP address whitelist must be in one of the following formats:'."\n" ."\n" .'* IP addresses, such as `10.10.XX.XX`.'."\n" .'* CIDR blocks, such as `10.10.XX.XX/24`. In this example, **24** indicates that the prefix of each IP address in the IP address whitelist is 24 bits in length. You can replace 24 with a value within the range of **1 to 32**.'."\n", 'type' => 'string', 'required' => false, 'example' => '10.10.XX.XX', ], 'VSwitchID' => [ 'description' => 'The vSwitch ID of the unit node that you want to create.'."\n", 'type' => 'string', 'required' => true, 'example' => 'vsw-bp1tg609m5j85****', ], 'VpcID' => [ 'description' => 'The virtual private cloud (VPC) ID of the unit node that you want to create.'."\n", 'type' => 'string', 'required' => true, 'example' => 'vpc-bp19ame5m1r3o****', ], 'ZoneID' => [ 'description' => 'The zone ID of the unit node that you want to create. You can call the DescribeRegions operation to query the zone ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-h', ], 'ZoneIDSlave1' => [ 'description' => 'The zone ID of the secondary node of the unit node that you want to create. You can call the DescribeRegions operation to query the zone ID.'."\n" ."\n" .'* If the value of this parameter is the same as the **zone ID** of the unit node that you want to create, the single-zone deployment method is used.'."\n" .'* If the value of this parameter is different from the **zone ID** of the unit node that you want to create, the multiple-zone deployment method is used.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-h', ], 'ZoneIDSlave2' => [ 'description' => 'The zone ID of the logger node of the unit node that you want to create. You can call the DescribeRegions operation to query the zone ID.'."\n" ."\n" .'* If the value of this parameter is the same as the **zone ID** of the unit node that you want to create, the single-zone deployment method is used.'."\n" .'* If the value of this parameter is different from the **zone ID** of the unit node that you want to create, the multiple-zone deployment method is used.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-h', ], ], 'required' => false, ], 'required' => true, 'maxItems' => 9, 'minItems' => 1, ], ], [ 'name' => 'CentralRdsDtsAdminAccount', 'in' => 'query', 'schema' => [ 'description' => 'The username of the privileged account of the central node. You can call the DescribeAccounts operation to query the privileged account of the central node.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test', ], ], [ 'name' => 'CentralRdsDtsAdminPassword', 'in' => 'query', 'schema' => [ 'description' => 'The password of the privileged account of the central node.'."\n", 'type' => 'string', 'required' => true, 'example' => 'Test12345', ], ], [ 'name' => 'DBList', 'in' => 'query', 'schema' => [ 'description' => 'A JSON array that consists of the information about the databases on the central node. All database information that you specify in this array is synchronized to the unit nodes of the global active database cluster. The JSON array contains the following fields:'."\n" ."\n" .'* **name**: the name of the database.'."\n" .'* **all**: specifies whether to synchronize all data in the database or the table. Valid values: **true** and **false**.'."\n" .'* **Table**: the name of the table. If you set the **all** field to **false**, you must nest the name of the table that you want to synchronize into the JSON array.'."\n" ."\n" .'Example: `{ "testdb": { "name": "testdb", "all": false, "Table": { "order": { "name": "order", "all": true }, "ordernew": { "name": "ordernew", "all": true } } } }`'."\n" ."\n" .'> For more information, see [Objects of DTS tasks](~~209545~~).'."\n", 'type' => 'string', 'required' => true, 'example' => '{ "testdb": { "name": "testdb", "all": false, "Table": { "order": { "name": "order", "all": true }, "ordernew": { "name": "ordernew", "all": true } } } }', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '16C62438-491B-5C02-9B49-BA924A1372A2', ], 'Result' => [ 'description' => 'An array that consists of the information returned.'."\n", 'type' => 'object', 'properties' => [ 'CreateCount' => [ 'description' => 'The number of unit nodes that are created by calling this operation.'."\n", 'type' => 'string', 'example' => '2', ], 'GadInstanceName' => [ 'description' => 'The ID of the global active database cluster.'."\n", 'type' => 'string', 'example' => 'gad-rm-bp1npi2j8********', ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', ], [ 'errorCode' => 'CreateGlobalActiveDatabase.GadInstanceNotActive', 'errorMessage' => 'gad instance not in active', ], [ 'errorCode' => 'CreateGlobalActiveDatabaseFailed.CentralNodeNotSupportGAD', 'errorMessage' => 'CentralNode DB not support GAD', ], [ 'errorCode' => 'CreateGlobalActiveDatabaseFailed.UnitMemberParamsEmpty', 'errorMessage' => 'UnitMemberParams not valid', ], [ 'errorCode' => 'CreateGlobalActiveDatabaseFailed.UnitMemberParamsError', 'errorMessage' => 'UnitMemberParams not valid', ], [ 'errorCode' => 'CreateGlobalActiveDatabaseFailed.GadNameNotMatchCentralNode', 'errorMessage' => 'the gadInstanceName not match with the central node', ], [ 'errorCode' => 'CreateGlobalActiveDatabaseFailed.GadInstanceExists', 'errorMessage' => 'gad instance has exists,please add member!', ], [ 'errorCode' => 'CreateGlobalActiveDatabaseFailed.GadInstanceNotExists', 'errorMessage' => 'gad instance not exists,please create GAD!', ], [ 'errorCode' => 'CreateGlobalActiveDatabase.GadInstanceNotFound', 'errorMessage' => 'gad instance not Found', ], [ 'errorCode' => 'CreateGlobalActiveDatabase.GetInstanceMemberFaied', 'errorMessage' => 'get instance member list failed', ], [ 'errorCode' => 'CreateGlobalActiveDatabaseImpl.preCheckGadInstance', 'errorMessage' => 'exceed max member count 10', ], [ 'errorCode' => 'CreateGlobalActiveDatabaseImpl.preCheckMemberParams', 'errorMessage' => 'centralNode not exists', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'staticInfo' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16C62438-491B-5C02-9B49-BA924A1372A2\\",\\n \\"Result\\": {\\n \\"CreateCount\\": \\"2\\",\\n \\"GadInstanceName\\": \\"gad-rm-bp1npi2j8****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 16C62438-491B-5C02-9B49-BA924A1372A2\\n \\n 1\\n gad-rm-bp1npi2j8****\\n \\n","errorExample":""}]', 'title' => 'CreateGadInstanceMember', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* RDS MySQL'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.'."\n" ."\n" .'[Add or remove unit nodes](~~331851~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DeleteGadInstance' => [ 'summary' => 'Deletes a global active database cluster.', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', ], 'parameters' => [ [ 'name' => 'GadInstanceName', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the global active database cluster. You can call the GadInstanceName operation to query the cluster ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gad-rm-bp1npi2j8********', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the central node of the global active database cluster. The central node refers to the primary node. You can call the DescribeGadInstances operation to query the region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The resource group ID. You can call the DescribeDBInstanceAttribute operation to query the resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy*****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '65BDA532-28AF-4122-AA39-B382721EEE64', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'Invalid DBInstanceId NotFound.', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'The parameter is invalid.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"65BDA532-28AF-4122-AA39-B382721EEE64\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n65BDA532-28AF-4122-AA39-B382721EEE64\\r\\n","errorExample":""}]', 'title' => 'DeleteGadInstance', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" ."\n" .'### [Usage notes](#)'."\n" ."\n" .'* A global active database cluster cannot be restored after it is deleted. Proceed with caution.'."\n" .'* If you delete a global active database cluster, the system removes all nodes and Data Transmission Service (DTS) synchronization tasks from the cluster. However, the system does not release the ApsaraDB RDS for MySQL instances that run as nodes in the cluster. If you no longer need the ApsaraDB RDS for MySQL instances, you can call the [DeleteDBInstance](~~26229~~) to release the instances one after another.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DetachGadInstanceMember' => [ 'summary' => 'Removes a unit node from a global active database cluster.', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'GadInstanceName', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the global active database cluster.'."\n", 'type' => 'string', 'required' => true, 'example' => 'gad-rm-bp1npi2j8********', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the central node. You can call the DescribeGadInstances operation to query the region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'MemberInstanceName', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the instance that serves as the unit node you want to remove. You can call the DescribeGadInstances query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-bp1npi2j8********', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The resource group ID. You can call the DescribeDBInstanceAttribute operation to query the resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy*****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '65BDA532-28AF-4122-AA39-B382721EEE64', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"65BDA532-28AF-4122-AA39-B382721EEE64\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n65BDA532-28AF-4122-AA39-B382721EEE64\\r\\n","errorExample":""}]', 'title' => 'DetachGadInstanceMember', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" ."\n" .'### [Usage notes](#)'."\n" ."\n" .'This operation can be used to remove only unit nodes.'."\n", ], 'DescribeGadInstances' => [ 'summary' => 'Queries the information about a global active database cluster or information about all global active database clusters in a region.', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'GadInstanceName', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the global active database cluster.'."\n" ."\n" .'* If you leave this parameter empty, this operation returns the details about all global active database clusters that are created within your Alibaba Cloud account.'."\n" .'* If you specify this parameter, this operation returns the details about the global active database cluster that you specify.'."\n" ."\n" .'> If you do not specify this parameter when you call this operation for the first time, the IDs of all clusters that are created by using the current account are returned. Then, you can specify the cluster ID to view the cluster details.'."\n", 'type' => 'string', 'required' => false, 'example' => 'gad-rm-bp1npi2j8********', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy*****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'GadInstances' => [ 'description' => 'The details about the global active database cluster.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'CreationTime' => [ 'description' => 'The time when the global active database cluster was created. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2021-10-21T02:57:08Z', ], 'Description' => [ 'description' => 'The name of the cluster.'."\n", 'type' => 'string', 'example' => 'GadTest', ], 'GadInstanceMembers' => [ 'description' => 'The information about each node in the cluster.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'DBInstanceID' => [ 'description' => 'The ID of the node.'."\n", 'type' => 'string', 'example' => 'rm-bp1npi2j8********', ], 'DtsInstance' => [ 'description' => 'A JSON array that consists of the details about the Data Transmission Service (DTS) synchronization task.'."\n" ."\n" .'> Each unit node (secondary node) synchronizes data from the central node (primary node) by using DTS. This parameter contains the synchronization link ID and request ID of DTS.'."\n", 'type' => 'string', 'example' => '{\\"dtsInstanceId\\":\\"dtsm9t107c********\\",\\"dtsRequestId\\":\\"190F0C6C-4BE6-5676-989B-DBDE6D34CD9C\\"}', ], 'Engine' => [ 'description' => 'The database engine that is run by the node.'."\n" ."\n" .'> The value of this parameter is fixed as **mysql**.'."\n", 'type' => 'string', 'example' => 'mysql', ], 'EngineVersion' => [ 'description' => 'The database engine version that is run by the node.'."\n", 'type' => 'string', 'example' => '8.0', ], 'RegionId' => [ 'description' => 'The ID of the region where the node resides.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], 'ResourceGroupId' => [ 'description' => 'The resource group ID.'."\n", 'type' => 'string', 'example' => 'rg-acfmy*****', ], 'Role' => [ 'description' => 'The type of the node. Valid values:'."\n" ."\n" .'* **CENTRAL**: The node is a central node. Each global active database cluster has only one central node. All unit nodes synchronize data from the central node.'."\n" .'* **UNIT**: The node is a unit node. Each global active database cluster can have up to 10 unit nodes. All unit nodes synchronize data from the central node.'."\n", 'type' => 'string', 'example' => 'CENTRAL', ], 'Status' => [ 'description' => 'The node status. Valid values:'."\n" ."\n" .'* **activation**: The node is running.'."\n" .'* **creating**: The node is being created.'."\n", 'type' => 'string', 'example' => 'activation', ], ], ], ], 'GadInstanceName' => [ 'description' => 'The ID of the global active database cluster.'."\n", 'type' => 'string', 'example' => 'gad-rm-bp1npi2j8********', ], 'ModificationTime' => [ 'description' => 'The time when the most recent modification was made to the global active database cluster. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2021-10-21T03:01:20Z', ], 'Service' => [ 'description' => 'The database engine that is run by the global active database cluster.'."\n" ."\n" .'> The value of this parameter is fixed as **mysql**.'."\n", 'type' => 'string', 'example' => 'mysql', ], 'Status' => [ 'description' => 'The status of the cluster. Valid values:'."\n" ."\n" .'* **activation**: The cluster is running.'."\n" .'* **creating**: The cluster is being created.'."\n" .'* **replica_adding**: Nodes are being added to the cluster.'."\n", 'type' => 'string', 'example' => 'activation', ], ], ], ], 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '76AF0609-4195-5DFC-BC78-3AD76FF872BB', ], ], 'title' => 'Schema of Response', ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"GadInstances\\": [\\n {\\n \\"CreationTime\\": \\"2021-10-21T02:57:08Z\\",\\n \\"Description\\": \\"GadTest\\",\\n \\"GadInstanceMembers\\": [\\n {\\n \\"DBInstanceID\\": \\"rm-bp1npi2j8****\\",\\n \\"DtsInstance\\": \\"{\\\\\\\\\\\\\\"dtsInstanceId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"dtsm9t107c****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"dtsRequestId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"190F0C6C-4BE6-5676-989B-DBDE6D34CD9C\\\\\\\\\\\\\\"}\\",\\n \\"Engine\\": \\"mysql\\",\\n \\"EngineVersion\\": \\"8.0\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ResourceGroupId\\": \\"rg-acfmy****\\",\\n \\"Role\\": \\"CENTRAL\\",\\n \\"Status\\": \\"activation\\"\\n }\\n ],\\n \\"GadInstanceName\\": \\"gad-rm-bp1npi2j8****\\",\\n \\"ModificationTime\\": \\"2021-10-21T03:01:20Z\\",\\n \\"Service\\": \\"mysql\\",\\n \\"Status\\": \\"activation\\"\\n }\\n ],\\n \\"RequestId\\": \\"76AF0609-4195-5DFC-BC78-3AD76FF872BB\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 76AF0609-4195-5DFC-BC78-3AD76FF872BB\\n \\n activation\\n 测试gad\\n gad-rm-bp1npi2j8********\\n 2021-10-21T02:57:08Z\\n mysql\\n 2021-10-21T03:01:20Z\\n \\n CENTRAL\\n activation\\n 8.0\\n rm-bp1npi2j8********\\n cn-hangzhou\\n mysql\\n \\n \\n UNIT\\n activation\\n 8.0\\n rm-bp10iyemc********\\n cn-hangzhou\\n {\\"dtsInstanceId\\":\\"dtsoai1091********\\",\\"dtsRequestId\\":\\"8E762933-4945-5FD0-B73E-B34DE97711D7\\"}\\n mysql\\n \\n \\n UNIT\\n activation\\n 8.0\\n rm-bp12srz4r********\\n cn-hangzhou\\n {\\"dtsInstanceId\\":\\"dtsqu710mn********\\",\\"dtsRequestId\\":\\"38500624-625E-503F-B3F7-D958BD092814\\"}\\n mysql\\n \\n \\n UNIT\\n activation\\n 8.0\\n rm-bp13f617l********\\n cn-hangzhou\\n {\\"dtsInstanceId\\":\\"dtsm9t107c********\\",\\"dtsRequestId\\":\\"190F0C6C-4BE6-5676-989B-DBDE6D34CD9C\\"}\\n mysql\\n \\n \\n","errorExample":""}]', 'title' => 'DescribeGadInstances', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ReceiveDBInstance' => [ 'summary' => 'Switches a primary instance to a disaster recovery instance or a disaster recovery instance to a primary instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the primary instance. You can call the [DescribeDBInstances](~~26232~~) operation to query the ID of the primary instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5*****', ], ], [ 'name' => 'GuardDBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the disaster recovery instance. You can call the [DescribeDBInstances](~~26232~~) operation to query the ID of the disaster recovery instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-tr2whku*****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'GuardDBInstanceId' => [ 'description' => 'The ID of the disaster recovery instance after the switchover.'."\n", 'type' => 'string', 'example' => 'rm-tr2whku*****', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'EFB6083A-7699-489B-8278-C0CB4793A96E', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'GuardInstance.Exist', 'errorMessage' => 'The guard instance has exist.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The specified instance does not exist or is not supported.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"GuardDBInstanceId\\": \\"rm-tr2whku*****\\",\\n \\"RequestId\\": \\"EFB6083A-7699-489B-8278-C0CB4793A96E\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 19806A9E-28A5-5C2F-BE0E-5BE2A4063B74\\n rm-bp1**************\\n","errorExample":""}]', 'title' => 'ReceiveDBInstance', 'description' => 'The operation is phased out.'."\n", ], 'TagResources' => [ 'summary' => 'Creates and adds tags to one or more instances.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'ResourceType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the resource. Set the value to **INSTANCE**.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'INSTANCE', ], ], [ 'name' => 'ResourceId', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The instance ID.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The instance ID. You can add tags to N instances at a time. Valid values of N: 1 to 50.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rm-uf6wjk5xxxxxxx', ], 'required' => true, 'example' => 'rm-uf6wjk5xxxxxxx', 'maxItems' => 51, ], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The list of tags.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Key' => [ 'description' => 'The key of the tag. You can create N tag keys at a time. Valid values of N: **1** to **20**. The value of this parameter cannot be an empty string.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testkey1', ], 'Value' => [ 'description' => 'The value of the tag. You can create N tag values at a time. Valid values of N: **1** to **20**. The value of this parameter can be an empty string.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testvalue1', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 21, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '224DB9F7-3100-4899-AB9C-C938BCCB43E7', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'NumberExceed.Tags', 'errorMessage' => 'The maximum number of Tags is exceeded. The maximum value is 20.', ], [ 'errorCode' => 'MissingParameter', 'errorMessage' => 'The parameter - ResourceIds.N should not be null', ], [ 'errorCode' => 'InvalidTagKey.Malformed', 'errorMessage' => 'The Tag.N.Key parameter is blank', ], [ 'errorCode' => 'InvalidTagValue.Malformed', 'errorMessage' => 'The Tag.N.Value parameter is blank', ], [ 'errorCode' => 'Duplicate.TagKey', 'errorMessage' => 'The Tag.N.Key contain duplicate key.', ], [ 'errorCode' => 'OperationDenied.QuotaExceed', 'errorMessage' => 'The maximum number of Tags is exceeded.', ], [ 'errorCode' => 'NumberExceed.ResourceIds', 'errorMessage' => 'The maximum number of ResourceIds is exceeded. The maximum value is 50.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'InvalidParameter.ResourceType', 'errorMessage' => 'The parameter ResourceType is invalid.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], [ 'errorCode' => 'InvalidRCInstanceName.NotFound', 'errorMessage' => 'The RDS Custom instance was not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"224DB9F7-3100-4899-AB9C-C938BCCB43E7\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n224DB9F7-3100-4899-AB9C-C938BCCB43E7\\r\\n","errorExample":""}]', 'title' => 'TagResources', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" .'* MariaDB'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> : Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.'."\n" ."\n" .'* [Create tags for an ApsaraDB RDS for MySQL instance](~~96149~~)'."\n" .'* [Create tags for an ApsaraDB RDS for PostgreSQL instance](~~96777~~)'."\n" .'* [Create tags for an ApsaraDB RDS for SQL Server instance](~~95726~~)'."\n" .'* [Create tags for an ApsaraDB RDS for MariaDB instance](~~97152~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'AddTagsToResource' => [ 'summary' => 'Adds tags to an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the generated token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxx', ], ], [ 'name' => 'proxyId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the proxy mode.'."\n", 'type' => 'string', 'required' => false, 'example' => 'API', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hagnzhou', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID.'."\n" ."\n" .'> You can enter up to 30 instance IDs in a single request. If you enter more than one instance ID, you must separate the instance IDs with commas (,).'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5xxxxxxx', ], ], [ 'name' => 'Tags', 'in' => 'query', 'schema' => [ 'description' => 'The tags that you want to add. Each tag consists of a tag key and a tag value. You can specify a maximum of five tags in the following format for each request: {"key1":"value1","key2":"value2"...}.'."\n" ."\n" .'> The tag key is required and the tag value is optional.'."\n", 'type' => 'string', 'required' => false, 'example' => '{“key1”:”value1”,“key2”:””}', ], ], [ 'name' => 'Tag.1.key', 'in' => 'query', 'schema' => [ 'description' => 'The tag key of the first tag that you want to add. Each tag consists of a tag key and a tag value. You can specify up to five tags in a single request. You cannot specify an empty string as the tag key. You can specify an empty string as the tag value.'."\n", 'type' => 'string', 'required' => false, 'example' => 'key1', ], ], [ 'name' => 'Tag.2.key', 'in' => 'query', 'schema' => [ 'description' => 'The tag key of the second tag that you want to add. Each tag consists of a tag key and a tag value. You can specify up to five tags in a single request. You cannot specify an empty string as the tag key. You can specify an empty string as the tag value.'."\n", 'type' => 'string', 'required' => false, 'example' => 'key2', ], ], [ 'name' => 'Tag.3.key', 'in' => 'query', 'schema' => [ 'description' => 'The tag key of the third tag that you want to add. Each tag consists of a tag key and a tag value. You can specify up to five tags in a single request. You cannot specify an empty string as the tag key. You can specify an empty string as the tag value.'."\n", 'type' => 'string', 'required' => false, 'example' => 'key3', ], ], [ 'name' => 'Tag.4.key', 'in' => 'query', 'schema' => [ 'description' => 'The tag key of the fourth tag that you want to add. Each tag consists of a tag key and a tag value. You can specify up to five tags in a single request. You cannot specify an empty string as the tag key. You can specify an empty string as the tag value.'."\n", 'type' => 'string', 'required' => false, 'example' => 'key4', ], ], [ 'name' => 'Tag.5.key', 'in' => 'query', 'schema' => [ 'description' => 'The tag key of the fifth tag that you want to add. Each tag consists of a tag key and a tag value. You can specify up to five tags in a single request. You cannot specify an empty string as the tag key. You can specify an empty string as the tag value.'."\n", 'type' => 'string', 'required' => false, 'example' => 'key5', ], ], [ 'name' => 'Tag.1.value', 'in' => 'query', 'schema' => [ 'description' => 'The tag value of the first tag that you want to add. Each tag consists of a tag key and a tag value. You can specify up to five tags in a single request. You cannot specify an empty string as the tag key. You can specify an empty string as the tag value.'."\n", 'type' => 'string', 'required' => false, 'example' => 'value1', ], ], [ 'name' => 'Tag.2.value', 'in' => 'query', 'schema' => [ 'description' => 'The tag value of the second tag that you want to add. Each tag consists of a tag key and a tag value. You can specify up to five tags in a single request. You cannot specify an empty string as the tag key. You can specify an empty string as the tag value.'."\n", 'type' => 'string', 'required' => false, 'example' => 'value2', ], ], [ 'name' => 'Tag.3.value', 'in' => 'query', 'schema' => [ 'description' => 'The tag value of the third tag that you want to add. Each tag consists of a tag key and a tag value. You can specify up to five tags in a single request. You cannot specify an empty string as the tag key. You can specify an empty string as the tag value.'."\n", 'type' => 'string', 'required' => false, 'example' => 'value3', ], ], [ 'name' => 'Tag.4.value', 'in' => 'query', 'schema' => [ 'description' => 'The tag value of the fourth tag that you want to add. Each tag consists of a tag key and a tag value. You can specify up to five tags in a single request. You cannot specify an empty string as the tag key. You can specify an empty string as the tag value.'."\n", 'type' => 'string', 'required' => false, 'example' => 'value4', ], ], [ 'name' => 'Tag.5.value', 'in' => 'query', 'schema' => [ 'description' => 'The tag value of the fifth tag that you want to add. Each tag consists of a tag key and a tag value. You can specify up to five tags in a single request. You cannot specify an empty string as the tag key. You can specify an empty string as the tag value.'."\n", 'type' => 'string', 'required' => false, 'example' => 'value5', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy*****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '224DB9F7-3100-4899-AB9C-C938BCCB43E7', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], [ [ 'errorCode' => 'InvalidTagKey.Malformed', 'errorMessage' => 'Malformed tag key.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"224DB9F7-3100-4899-AB9C-C938BCCB43E7\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"7463B73D-35CC-4D19-A010-6B8D65D242EF\\",\\n \\"HostId\\": \\"rds.aliyuncs.com\\",\\n \\"Code\\": \\"UnsupportedOperation\\",\\n \\"Message\\": \\"The specified action is not supported.\\"\\n}"},{"type":"xml","example":"\\n\\n\\t224DB9F7-3100-4899-AB9C-C938BCCB43E7\\n\\t","errorExample":""}]', 'title' => 'AddTagsToResource', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" .'* MariaDB'."\n" ."\n" .'### [](#)Usage notes'."\n" ."\n" .'* Each tag consists of a tag key and a tag value. The tag key is required, and the tag value is optional.'."\n" .'* The tag key and tag value cannot start with aliyun.'."\n" .'* The tag key and tag value are not case-sensitive.'."\n" .'* The maximum length of a tag key is 64 characters, and the maximum length of a tag value is 128 characters.'."\n" .'* A maximum of 10 tags can be added to each instance. Each tag that is added to the same instance must have a unique tag key. If you add a new tag to the instance and the key of the new tag is the same as that of an existing tag, the new tag overwrites the existing tag.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'UntagResources' => [ 'summary' => 'Removes tags from one or more instances.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'ResourceType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the resource. Set the value to **INSTANCE**.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'INSTANCE', ], ], [ 'name' => 'All', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to delete all tags of the instance. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n" ."\n" .'Default value: **false**.'."\n" ."\n" .'> This parameter is valid if parameters that contain **TagKey.N** are not specified.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'ResourceId', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The instance ID. You can remove tags from N instances at a time. Valid values of N: **1** to **50**.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rm-uf6wjk5xxxxxxx', ], 'required' => true, 'example' => 'rm-uf6wjk5xxxxxxx', 'maxItems' => 51, ], ], [ 'name' => 'TagKey', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The list of tag keys. You can delete N tag keys at a time. Valid values of N: **1** to **20**. The value of this parameter cannot be an empty string.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The key of the tag.'."\n", 'type' => 'string', 'required' => false, 'example' => 'key1', ], 'required' => false, 'example' => 'testkey1', 'maxItems' => 21, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '601B6F25-21E7-4484-99D5-3EF2625C0088', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'NumberExceed.Tags', 'errorMessage' => 'The number of parameter Tags is exceed, Valid : 20', ], [ 'errorCode' => 'NumberExceed.ResourceIds', 'errorMessage' => 'The number of ResourceIds parameter is exceed , Valid : 50', ], [ 'errorCode' => 'InvalidTagValue.Malformed', 'errorMessage' => 'The Tag.N.Value parameter is blank', ], [ 'errorCode' => 'MissingParameter', 'errorMessage' => 'The parameter - ResourceIds.N should not be null', ], [ 'errorCode' => 'InvalidTagKey.Malformed', 'errorMessage' => 'The Tag.N.Key parameter is blank', ], [ 'errorCode' => 'InvalidResourceId.NotFound', 'errorMessage' => 'ResourceId does not refer to an existing DB instance.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'InvalidParameter.ResourceType', 'errorMessage' => 'The parameter ResourceType is invalid.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"601B6F25-21E7-4484-99D5-3EF2625C0088\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 601B6F25-21E7-4484-99D5-3EF2625C0088\\r\\n","errorExample":""}]', 'title' => 'UntagResources', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" .'* MariaDB'."\n" ."\n" .'### [](#)Usage notes'."\n" ."\n" .'* You can remove up to 20 tags at a time.'."\n" .'* If a tag is removed from an instance and is not added to other instances, the tag is automatically deleted.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'RemoveTagsFromResource' => [ 'summary' => 'Removes tags from an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxxxxx', ], ], [ 'name' => 'proxyId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the proxy mode.'."\n", 'type' => 'string', 'required' => false, 'example' => 'API', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-uf6wjk5xxxxxxx', ], ], [ 'name' => 'Tags', 'in' => 'query', 'schema' => [ 'description' => 'A set of a TagKey and a TagValue that you use to unbind the tag. Format: {"key1":"value1"}.'."\n" ."\n" .'> You cannot specify an empty string for TagKey. You can specify an empty string for TagValue.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"key1":"value1"}', ], ], [ 'name' => 'Tag.1.key', 'in' => 'query', 'schema' => [ 'description' => 'The TagKey of the first tag that you want to unbind. Each tag consists of a TagKey and a TagValue. You can specify up to five tags in a single request. You cannot specify an empty string as the tag key. You can specify an empty string as the tag value.'."\n", 'type' => 'string', 'required' => false, 'example' => 'key1', ], ], [ 'name' => 'Tag.2.key', 'in' => 'query', 'schema' => [ 'description' => 'The TagKey of the second tag that you want to unbind. Each tag consists of a TagKey and a TagValue. You can specify up to five tags in a single request. You cannot specify an empty string as the tag key. You can specify an empty string as the tag value.'."\n", 'type' => 'string', 'required' => false, 'example' => 'key2', ], ], [ 'name' => 'Tag.3.key', 'in' => 'query', 'schema' => [ 'description' => 'The TagKey of the third tag that you want to unbind. Each tag consists of a TagKey and a TagValue. You can specify up to five tags in a single request. You cannot specify an empty string as the tag key. You can specify an empty string as the tag value.'."\n", 'type' => 'string', 'required' => false, 'example' => 'key3', ], ], [ 'name' => 'Tag.4.key', 'in' => 'query', 'schema' => [ 'description' => 'The TagKey of the fourth tag that you want to unbind. Each tag consists of a TagKey and a TagValue. You can specify up to five tags in a single request. You cannot specify an empty string as the tag key. You can specify an empty string as the tag value.'."\n", 'type' => 'string', 'required' => false, 'example' => 'key4', ], ], [ 'name' => 'Tag.5.key', 'in' => 'query', 'schema' => [ 'description' => 'The TagKey of the fifth tag that you want to unbind. Each tag consists of a TagKey and a TagValue. You can specify up to five tags in a single request. You cannot specify an empty string as the tag key. You can specify an empty string as the tag value.'."\n", 'type' => 'string', 'required' => false, 'example' => 'key5', ], ], [ 'name' => 'Tag.1.value', 'in' => 'query', 'schema' => [ 'description' => 'The TagValue of the first tag that you want to unbind. Each tag consists of a TagKey and a TagValue. You can specify up to five tags in a single request. You cannot specify an empty string as the tag key. You can specify an empty string as the tag value.'."\n", 'type' => 'string', 'required' => false, 'example' => 'value1', ], ], [ 'name' => 'Tag.2.value', 'in' => 'query', 'schema' => [ 'description' => 'The TagValue of the second tag that you want to unbind. Each tag consists of a TagKey and a TagValue. You can specify up to five tags in a single request. You cannot specify an empty string as the tag key. You can specify an empty string as the tag value.'."\n", 'type' => 'string', 'required' => false, 'example' => 'value2', ], ], [ 'name' => 'Tag.3.value', 'in' => 'query', 'schema' => [ 'description' => 'The TagValue of the third tag that you want to unbind. Each tag consists of a TagKey and a TagValue. You can specify up to five tags in a single request. You cannot specify an empty string as the tag key. You can specify an empty string as the tag value.'."\n", 'type' => 'string', 'required' => false, 'example' => 'value4', ], ], [ 'name' => 'Tag.4.value', 'in' => 'query', 'schema' => [ 'description' => 'The TagValue of the fourth tag that you want to unbind. Each tag consists of a TagKey and a TagValue. You can specify up to five tags in a single request. You cannot specify an empty string as the tag key. You can specify an empty string as the tag value.'."\n", 'type' => 'string', 'required' => false, 'example' => 'value4', ], ], [ 'name' => 'Tag.5.value', 'in' => 'query', 'schema' => [ 'description' => 'The TagValue of the fifth tag that you want to unbind. Each tag consists of a TagKey and a TagValue. You can specify up to five tags in a single request. You cannot specify an empty string as the tag key. You can specify an empty string as the tag value.'."\n", 'type' => 'string', 'required' => false, 'example' => 'value5', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The resource group ID. You can call the ListResourceGroups operation to query the resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy*****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'AE00ACCD-1CF9-4920-9BB9-0175EFF43405', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"AE00ACCD-1CF9-4920-9BB9-0175EFF43405\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"7463B73D-35CC-4D19-A010-6B8D65D242EF\\",\\n \\"HostId\\": \\"rds.aliyuncs.com\\",\\n \\"Code\\": \\"UnsupportedOperation\\",\\n \\"Message\\": \\"The specified action is not supported.\\"\\n}"},{"type":"xml","example":"\\n\\n\\tAE00ACCD-1CF9-4920-9BB9-0175EFF43405\\n\\t","errorExample":""}]', 'title' => 'RemoveTagsFromResource', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" .'* MariaDB'."\n" ."\n" .'### [](#)Usage notes'."\n" ."\n" .'* A maximum of 10 tags can be removed in a single request.'."\n" .'* If a tag is removed from all instances to which the tag is added, the tag is automatically deleted.'."\n" .'* If you specify only TagKey, all tags that match the TagKey condition are removed.'."\n" .'* You must specify at least TagKey or a pair of TagKey and TagValue.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ListTagResources' => [ 'summary' => 'Queries the tags that are added to one or more instances.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'ResourceType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the resource. Set the value to **INSTANCE**.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'INSTANCE', ], ], [ 'name' => 'NextToken', 'in' => 'query', 'schema' => [ 'description' => 'The token required to obtain more results. This parameter is not required in the first query. If a query does not return all results, you can specify the token returned from the previous query for the next query to obtain more results.'."\n", 'type' => 'string', 'required' => false, 'example' => '212db86sca4384811e0b5e8707ec21345', ], ], [ 'name' => 'ResourceId', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The instance ID. You can specify a maximum of **50** instance IDs.****'."\n" ."\n" .'> You must specify at least one of the **ResourceId** and **Key** parameters.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rm-uf6wjk5*******', ], 'required' => false, 'example' => 'rm-uf6wjk5xxxxxxx', 'maxItems' => 51, ], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The tag list.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Key' => [ 'description' => 'The tag key. You can query N tag keys at a time. Valid values of N: **1** to **20**. The value cannot be an empty string.'."\n" ."\n" .'> You must specify at least one of the **ResourceId** and **Key** parameters.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testkey1', ], 'Value' => [ 'description' => 'The tag value that is associated with the specified tag key. You can specify N tag values at a time. Valid values of N: **1** to **20**. The value can be an empty string.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testvalue1', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 21, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'NextToken' => [ 'description' => 'You must specify the token that is obtained from the previous query as the value of NextToken.'."\n", 'type' => 'string', 'example' => '212db86sca4384811e0b5e8707ec21345', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '47A514A1-4B77-4E30-B4C5-2A880650B3FD', ], 'TagResources' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'TagResource' => [ 'description' => 'The list of queried instances and tags.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'ResourceId' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5xxxxxxx', ], 'ResourceType' => [ 'description' => 'The resource type. The value `ALIYUN::RDS::INSTANCE` indicates ApsaraDB RDS instances.'."\n", 'type' => 'string', 'example' => 'ALIYUN::RDS::INSTANCE', ], 'TagKey' => [ 'description' => 'The tag key.'."\n", 'type' => 'string', 'example' => 'testkey1', ], 'TagValue' => [ 'description' => 'The tag value that is associated with the specified tag key.'."\n", 'type' => 'string', 'example' => 'testvalue1', ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'BothEmpty.TagsAndResources', 'errorMessage' => 'The specified Tags and ResourcesIds are not allow to both empty.', ], [ 'errorCode' => 'NumberExceed.Tags', 'errorMessage' => 'The number of Tags parameter is exceed, Valid : 20', ], [ 'errorCode' => 'NumberExceed.ResourceIds', 'errorMessage' => 'The number of ResourceIds parameter is exceed , Valid : 50', ], [ 'errorCode' => 'InvalidParameter.ResourceType', 'errorMessage' => 'The parameter ResourceType is invalid.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'InvalidRCDeploymentName.NotFound', 'errorMessage' => 'The RDS deployment set cannot be found. Check the values of the request parameters.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"212db86sca4384811e0b5e8707ec21345\\",\\n \\"RequestId\\": \\"47A514A1-4B77-4E30-B4C5-2A880650B3FD\\",\\n \\"TagResources\\": {\\n \\"TagResource\\": [\\n {\\n \\"ResourceId\\": \\"rm-uf6wjk5****\\",\\n \\"ResourceType\\": \\"ALIYUN::RDS::INSTANCE\\",\\n \\"TagKey\\": \\"testkey1\\",\\n \\"TagValue\\": \\"testvalue1\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n\\n \\n ALIYUN::RDS::INSTANCE\\n testvalue1\\n rm-uf6wjk5xxxxxxx\\n testkey1\\n \\n\\n47A514A1-4B77-4E30-B4C5-2A880650B3FD\\n","errorExample":""}]', 'title' => 'ListTagResources', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" .'* MariaDB'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeTags' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOC****', ], ], [ 'name' => 'proxyId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the proxy mode.'."\n", 'type' => 'string', 'required' => false, 'example' => 'API', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n" ."\n" .'> If you specify this parameter, all tags that are added to this instance are queried, and other filter conditions becomes invalid.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rm-uf6wjk5****', ], ], [ 'name' => 'Tags', 'in' => 'query', 'schema' => [ 'description' => 'The tag that you want to query. The value of the parameter consists of TagKey and TagValue. Format: `{"TagKey":"TagValue"}`.'."\n", 'type' => 'string', 'required' => false, 'example' => '{“key1”:”value1”}', ], ], [ 'name' => 'ResourceType', 'in' => 'query', 'schema' => [ 'description' => 'The type of resource. Set the value to INSTANCE.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'enumValueTitles' => [ 'INSTANCE' => 'INSTANCE', ], 'example' => 'INSTANCE', 'default' => 'INSTANCE', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Items' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'TagInfos' => [ 'description' => 'The tags that are added to the instance.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the tag.'."\n", 'type' => 'object', 'properties' => [ 'DBInstanceIds' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'DBInstanceIds' => [ 'description' => 'The IDs of the instances to which the tag is added.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The ID of the instance to which the tag is added.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5****', ], ], ], ], 'TagKey' => [ 'description' => 'The tag key.'."\n", 'type' => 'string', 'example' => 'key1', ], 'TagValue' => [ 'description' => 'The tag value.'."\n", 'type' => 'string', 'example' => 'value1', ], ], ], ], ], ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Tag.NoRegionIdExist', 'errorMessage' => 'the region Id can not be blank.', ], [ 'errorCode' => 'Tag.NoTagInfoExist', 'errorMessage' => 'all the tags and tagN parameters is null.', ], [ 'errorCode' => 'Tag.TagKeyCanNotBeAll', 'errorMessage' => 'tag key can not be all.', ], [ 'errorCode' => 'Tag.TagKeyDuplex', 'errorMessage' => 'tag key must be sole in one operation.', ], [ 'errorCode' => 'Tag.NoDBInstanceIdExist', 'errorMessage' => 'the dbinstance Id can not be blank.', ], [ 'errorCode' => 'Tag.TooManyDBInstanceIds', 'errorMessage' => 'the dbinstance Ids is more than 30.', ], [ 'errorCode' => 'Tag.TooManyTagsForOneInstance', 'errorMessage' => 'total 10 tags can be added to one resource.', ], [ 'errorCode' => 'Tag.Allow5TagInfos', 'errorMessage' => 'only 5 tags allowed in one operation.', ], [ 'errorCode' => 'Tag.TagKeyIsBlank', 'errorMessage' => 'tag key can not be blank.', ], [ 'errorCode' => 'Tag.TagKeyStartWith.aliyun', 'errorMessage' => 'tag key and value can not be started with aliyun.', ], [ 'errorCode' => 'Tag.TagKeyTooLong', 'errorMessage' => 'the max length of tag key is 64.', ], [ 'errorCode' => 'Tag.TagValueTooLong', 'errorMessage' => 'the max length of tag value is 128.', ], [ 'errorCode' => 'Tag.Malformed', 'errorMessage' => 'The specified parameter Tag is not valid.', ], [ 'errorCode' => 'Tag.SetTagInfoAtTwoParameter', 'errorMessage' => 'only tags or tagN parameter could be setted.', ], [ 'errorCode' => 'Tag.InvalidTagsParameter', 'errorMessage' => 'tags parameter is invalid.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Items\\": {\\n \\"TagInfos\\": [\\n {\\n \\"DBInstanceIds\\": {\\n \\"DBInstanceIds\\": [\\n \\"rm-uf6wjk5****\\"\\n ]\\n },\\n \\"TagKey\\": \\"key1\\",\\n \\"TagValue\\": \\"value1\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"7463B73D-35CC-4D19-A010-6B8D65D242EF\\",\\n \\"HostId\\": \\"rds.aliyuncs.com\\",\\n \\"Code\\": \\"UnsupportedOperation\\",\\n \\"Message\\": \\"The specified action is not supported.\\"\\n}"},{"type":"xml","example":"\\n\\n\\t\\n\\t\\t\\n\\t\\t\\t1\\n\\t\\t\\t测试\\n\\t\\t\\t\\n\\t\\t\\t\\trm-uf6wjk5xxxxxxx\\n\\t\\t\\t\\n\\t\\t\\n\\t\\n\\t6D709088-6D7D-4152-99F4-C2FE86463862\\t\\n\\n\\t","errorExample":""}]', 'title' => 'DescribeTags', 'summary' => 'Queries tags of an instance.', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" .'* MariaDB'."\n" ."\n" .'### [Usage notes](#)'."\n" ."\n" .'* If an instance ID is specified, all tags that are added to this instance are queried, and other filter conditions are invalid.'."\n" .'* If you specify only TagKey, the results that match the specified TagKey are returned. If you specify both TagKey and TagValue, the results that match both the specified TagKey and TagValue are returned.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeDBInstanceByTags' => [ 'summary' => 'Queries information about the tags that are added to an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCz*****', ], ], [ 'name' => 'proxyId', 'in' => 'query', 'schema' => [ 'description' => 'A deprecated parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'None', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rm-uf6w**********', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page. Valid values: **30 to 100**. Default value: **30**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '30', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => 'The page number. Pages start from page 1.'."\n" ."\n" .'Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '0', 'example' => '1', 'default' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Items' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'DBInstanceTag' => [ 'description' => 'The details about the instance.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details about the instance.'."\n", 'type' => 'object', 'properties' => [ 'DBInstanceId' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-uf6w**********', ], 'Tags' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Tag' => [ 'description' => 'The details about the tag.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The tag details.'."\n", 'type' => 'object', 'properties' => [ 'TagKey' => [ 'description' => 'The tag key.'."\n", 'type' => 'string', 'example' => 'key1', ], 'TagValue' => [ 'description' => 'The tag value.'."\n", 'type' => 'string', 'example' => 'value1', ], ], ], ], ], ], ], ], ], ], ], 'PageNumber' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageRecordCount' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', ], 'TotalRecordCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Tag.NoRegionIdExist', 'errorMessage' => 'the region Id can not be blank.', ], [ 'errorCode' => 'Tag.NoTagInfoExist', 'errorMessage' => 'all the tags and tagN parameters is null.', ], [ 'errorCode' => 'Tag.TagKeyCanNotBeAll', 'errorMessage' => 'tag key can not be all.', ], [ 'errorCode' => 'Tag.TagKeyDuplex', 'errorMessage' => 'tag key must be sole in one operation.', ], [ 'errorCode' => 'Tag.NoDBInstanceIdExist', 'errorMessage' => 'the dbinstance Id can not be blank.', ], [ 'errorCode' => 'Tag.TooManyDBInstanceIds', 'errorMessage' => 'the dbinstance Ids is more than 30.', ], [ 'errorCode' => 'Tag.TooManyTagsForOneInstance', 'errorMessage' => 'total 10 tags can be added to one resource.', ], [ 'errorCode' => 'Tag.SetTagInfoAtTwoParamters', 'errorMessage' => 'only tags or tagN parameter could be setted.', ], [ 'errorCode' => 'Tag.Allow5TagInfos', 'errorMessage' => 'only 5 tags allowed in one operation.', ], [ 'errorCode' => 'Tag.TagKeyIsBlank', 'errorMessage' => 'tag key can not be blank.', ], [ 'errorCode' => 'Tag.TagKeyStartWith.aliyun', 'errorMessage' => 'tag key and value can not be started with aliyun.', ], [ 'errorCode' => 'Tag.TagKeyTooLong', 'errorMessage' => 'the max tag key s length is 64.', ], [ 'errorCode' => 'Tag.TagValueTooLong', 'errorMessage' => 'the max tag value is length is 128.', ], [ 'errorCode' => 'Tag.InvalidTagsParamter', 'errorMessage' => 'tags parameter is invalid.', ], [ 'errorCode' => 'Tag.Malformed', 'errorMessage' => 'The specified parameter Tag is not valid.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', ], [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Items\\": {\\n \\"DBInstanceTag\\": [\\n {\\n \\"DBInstanceId\\": \\"rm-uf6w****\\",\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"TagKey\\": \\"key1\\",\\n \\"TagValue\\": \\"value1\\"\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"PageNumber\\": 1,\\n \\"PageRecordCount\\": 10,\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"TotalRecordCount\\": 30\\n}","errorExample":""},{"type":"xml","example":"\\n 1AD222E9-E606-4A42-BF6D-8A4442913CEF\\n 1\\n 10\\n 30\\n \\n rm-uf6w**********\\n \\n value1\\n key1\\n \\n \\n","errorExample":""}]', 'title' => 'DescribeDBInstanceByTags', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" .'* MariaDB'."\n", ], 'CreatePostgresExtensions' => [ 'summary' => 'Creates an extension for a database.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the generated token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCz****', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'pgm-gc7f1****', ], ], [ 'name' => 'Extensions', 'in' => 'query', 'schema' => [ 'description' => 'The extension that you want to install. If you want to install multiple extensions, separate them with commas (,). If you do not specify the **SourceDatabase** parameter, you must specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'citext,pg_profile', ], ], [ 'name' => 'DBNames', 'in' => 'query', 'schema' => [ 'description' => 'The database name. You can call the DescribeDatabases operation to query the database name.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test_db', ], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => [ 'description' => 'The account of the user who owns the extension. Only privileged accounts are supported.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test_user', ], ], [ 'name' => 'SourceDatabase', 'in' => 'query', 'schema' => [ 'description' => 'The source database from which you want to synchronize the extension to the destination database. If you do not specify the **Extensions** parameter, you must specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'source_db', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy****', ], ], [ 'name' => 'RiskConfirmed', 'in' => 'query', 'schema' => [ 'description' => 'The risk description that you need to confirm. If your instance runs an outdated minor engine version, installing specific extensions on the instance poses security risks. Proceed with the installation only after you acknowledge these risks. Valid values:'."\n" ."\n" .'* true'."\n" .'* false'."\n" ."\n" .'> For more information about the risks, see [Limits on extension creation for ApsaraDB RDS for PostgreSQL instances](~~2587815~~).'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '7E4448A6-9FE6-4474-A0C1-AA7CFC772CAC', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidDBName.Format', 'errorMessage' => 'Specified DB name is not valid.', ], [ 'errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'Specified parameters is not valid.', ], [ 'errorCode' => 'InvalidAccountName.NotFound', 'errorMessage' => 'Specified account name does not exist.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'MinorVersionNotSupport', 'errorMessage' => 'The current database minor version does not support the operation.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', ], [ 'errorCode' => 'IncorrectAccountPrivilegeType', 'errorMessage' => 'Current account privilege type does not support this operation.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'Specified instance does not exist or not support.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7E4448A6-9FE6-4474-A0C1-AA7CFC772CAC\\"\\n}","type":"json"}]', 'title' => 'CreatePostgresExtensions', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'PostgreSQL'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> Before you call this operation, read the following topics and make sure that you fully understand the prerequisites and impacts of this operation.'."\n" ."\n" .'[Manage extensions](~~2402409~~)'."\n" ."\n" .'### [](#)Usage notes'."\n" ."\n" .'Install only the extensions that are supported by the major engine version of the instance. Otherwise, the installation fails.'."\n" ."\n" .'* For more information, see [Supported extensions](~~142340~~).'."\n" .'* You can call an API operation to query the major engine version of the instance. For more information, see [DescribeDBInstanceAttribute](~~610394~~).'."\n", ], 'DeletePostgresExtensions' => [ 'summary' => 'Deletes an extension from a database.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCz****', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'pgm-bp156o9ti493****', ], ], [ 'name' => 'Extensions', 'in' => 'query', 'schema' => [ 'description' => 'The name of the extension. If you want to specify multiple extensions, separate the extension names with commas (,).'."\n", 'type' => 'string', 'required' => true, 'example' => 'citext', ], ], [ 'name' => 'DBNames', 'in' => 'query', 'schema' => [ 'description' => 'The database on which the extension is installed. If you want to specify multiple databases, separate the databases with commas (,).'."\n", 'type' => 'string', 'required' => true, 'example' => 'test_db', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '7E4448A6-9FE6-4474-A0C1-AA7CFC772CAC', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidDBName.Format', 'errorMessage' => 'Specified DB name is not valid.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'Specified instance does not exist or not support.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7E4448A6-9FE6-4474-A0C1-AA7CFC772CAC\\"\\n}","type":"json"}]', 'title' => 'DeletePostgresExtensions', 'description' => '### Supported database engines'."\n" ."\n" .'RDS PostgreSQL'."\n" ."\n" .'### References'."\n" ."\n" .'> : Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.'."\n" ."\n" .'[Manage extensions](~~2402409~~)'."\n", ], 'UpdatePostgresExtensions' => [ 'summary' => 'Updates the version of an extension on a database.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCz****', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'pgm-gc7f1****', ], ], [ 'name' => 'Extensions', 'in' => 'query', 'schema' => [ 'description' => 'The name of the extension. Separate multiple extensions with commas (,).'."\n", 'type' => 'string', 'required' => true, 'example' => 'citext', ], ], [ 'name' => 'DBNames', 'in' => 'query', 'schema' => [ 'description' => 'The database name. You can call the DescribeDatabases operation to obtain the database name.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test_db', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '7E4448A6-9FE6-4474-A0C1-AA7CFC772CAC', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidDBName.Format', 'errorMessage' => 'Specified DB name is not valid.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'Specified instance does not exist or not support.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7E4448A6-9FE6-4474-A0C1-AA7CFC772CAC\\"\\n}","type":"json"}]', 'title' => 'UpdatePostgresExtensions', 'description' => '### Supported database engines'."\n" ."\n" .'RDS PostgreSQL'."\n" ."\n" .'### References'."\n" ."\n" .'> : Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.'."\n" ."\n" .'[Manage extensions](~~2402409~~)'."\n", ], 'DescribePostgresExtensions' => [ 'summary' => 'Queries extensions that are installed on a database.', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCz****', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'pgm-bp156o9ti493****'."\n", ], ], [ 'name' => 'DBName', 'in' => 'query', 'schema' => [ 'description' => 'The database name. You can call the DescribeDatabases operation to query the database name.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test_db', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'InstalledExtensions' => [ 'description' => 'The list of extensions that are installed on the specified database.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The extension that is installed on the specified database.'."\n", 'type' => 'object', 'properties' => [ 'Category' => [ 'description' => 'The category of the extension.'."\n" ."\n" .'* **external_access**'."\n" .'* **index_support**'."\n" .'* **information_stat**'."\n" .'* **geography_space**'."\n" .'* **vector_engine**'."\n" .'* **timing_engine**'."\n" .'* **data_type**'."\n" .'* **encrypt_secure**'."\n" .'* **text_process**'."\n" .'* **operation_maintenance**'."\n" .'* **self_develop**'."\n", 'type' => 'string', 'example' => 'information_stat', ], 'Comment' => [ 'description' => 'The purpose of the extension.'."\n", 'type' => 'string', 'example' => 'PostgreSQL load profile repository and report builder', ], 'DefaultVersion' => [ 'description' => 'The default version of the extension.'."\n", 'type' => 'string', 'example' => '4.1', ], 'InstalledVersion' => [ 'description' => 'The current version of the extension.'."\n", 'type' => 'string', 'example' => '4.1', ], 'Name' => [ 'description' => 'The name of the extension.'."\n", 'type' => 'string', 'example' => 'pg_profile', ], 'Owner' => [ 'description' => 'The user of the extension.'."\n", 'type' => 'string', 'example' => 'test_user', ], 'Priority' => [ 'description' => 'The priority of the extension.'."\n" ."\n" .'* **0**: The extension is displayed by default.'."\n" .'* **1**: The extension is preferentially displayed.'."\n", 'type' => 'string', 'example' => '0', ], 'Requires' => [ 'description' => 'The extensions on which the current extension depends when it is installed.'."\n", 'type' => 'string', 'example' => '{dblink,plpgsql}', ], 'Uid' => [ 'description' => 'The ID of the Alibaba Cloud account.'."\n" ."\n" .'> This parameter is returned only for self-developed exclusive extensions. You can view exclusive extensions only within your Alibaba Cloud account.'."\n", 'type' => 'string', 'example' => '181578148294****', ], ], ], ], 'Overview' => [ 'description' => 'The overview of the extension.'."\n", 'type' => 'object', 'example' => 'None', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '7E4448A6-9FE6-4474-A0C1-AA7CFC772CAC', ], 'UninstalledExtensions' => [ 'description' => 'The list of extensions that are not installed on the specified database.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The extension that is not installed on the specified database.'."\n", 'type' => 'object', 'properties' => [ 'Category' => [ 'description' => 'The category of the extension.'."\n", 'type' => 'string', 'example' => 'information_stat', ], 'Comment' => [ 'description' => 'The purpose of the extension.'."\n", 'type' => 'string', 'example' => 'PostgreSQL load profile repository and report builder', ], 'DefaultVersion' => [ 'description' => 'The default version of the extension.'."\n", 'type' => 'string', 'example' => '4.1', ], 'InstalledVersion' => [ 'description' => 'The current version of the extension.'."\n", 'type' => 'string', 'example' => '4.1', ], 'Name' => [ 'description' => 'The name of the extension.'."\n", 'type' => 'string', 'example' => 'pg_cron', ], 'Owner' => [ 'description' => 'The user of the extension.'."\n", 'type' => 'string', 'example' => 'test_user', ], 'Priority' => [ 'description' => 'The priority of the extension.'."\n", 'type' => 'string', 'example' => '0', ], 'Requires' => [ 'description' => 'The extensions on which the current extension depends when it is installed.'."\n", 'type' => 'string', 'example' => '{dblink,plpgsql}', ], 'Uid' => [ 'description' => 'The ID of the Alibaba Cloud account.'."\n" ."\n" .'> This parameter is returned only for self-developed exclusive extensions. You can view exclusive extensions only within your Alibaba Cloud account.'."\n", 'type' => 'string', 'example' => '181578148294****', ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The specified DB instance name does not exist.', ], [ 'errorCode' => 'InvalidDBName.Format', 'errorMessage' => 'Specified DB name is not valid.', ], [ 'errorCode' => 'Database.QueryError', 'errorMessage' => 'Query Db failed, please check input value and instance status.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'Specified instance does not exist or not support.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"InstalledExtensions\\": [\\n {\\n \\"Category\\": \\"information_stat\\",\\n \\"Comment\\": \\"PostgreSQL load profile repository and report builder\\",\\n \\"DefaultVersion\\": \\"4.1\\",\\n \\"InstalledVersion\\": \\"4.1\\",\\n \\"Name\\": \\"pg_profile\\",\\n \\"Owner\\": \\"test_user\\",\\n \\"Priority\\": \\"0\\",\\n \\"Requires\\": \\"{dblink,plpgsql}\\",\\n \\"Uid\\": \\"181578148294****\\"\\n }\\n ],\\n \\"Overview\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"RequestId\\": \\"7E4448A6-9FE6-4474-A0C1-AA7CFC772CAC\\",\\n \\"UninstalledExtensions\\": [\\n {\\n \\"Category\\": \\"information_stat\\",\\n \\"Comment\\": \\"PostgreSQL load profile repository and report builder\\",\\n \\"DefaultVersion\\": \\"4.1\\",\\n \\"InstalledVersion\\": \\"4.1\\",\\n \\"Name\\": \\"pg_cron\\",\\n \\"Owner\\": \\"test_user\\",\\n \\"Priority\\": \\"0\\",\\n \\"Requires\\": \\"{dblink,plpgsql}\\",\\n \\"Uid\\": \\"181578148294****\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => 'DescribePostgresExtensions', 'description' => '### Supported database engines'."\n" ."\n" .'RDS PostgreSQL'."\n" ."\n" .'### References'."\n" ."\n" .'> : Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.'."\n" ."\n" .'[Manage extensions](~~2402409~~)'."\n", ], 'DeleteSlot' => [ 'summary' => 'Deletes a replication slot of an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request.'."\n" ."\n" .'You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOC****', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'pgm-bp102g323jd4****'."\n", ], ], [ 'name' => 'SlotName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the replication slot. You can call the DescribeSlots operation to query the name of the replication slot.'."\n", 'type' => 'string', 'required' => true, 'example' => 'slot_test01', ], ], [ 'name' => 'SlotStatus', 'in' => 'query', 'schema' => [ 'description' => 'The status of the replication slot. You can call the DescribeSlots operation to query the status of the replication slot. Valid values:'."\n" ."\n" .'* **ACTIVE**'."\n" .'* **INACTIVE**'."\n", 'type' => 'string', 'required' => true, 'enumValueTitles' => [], 'example' => 'INACTIVE', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the resource group. You can leave this parameter empty.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy*****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '2875D608-A228-53D7-B8C9-35F13EDCF36D', ], 'SlotName' => [ 'description' => 'The name of the replication slot.'."\n", 'type' => 'string', 'example' => 'slot_test01', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'Specified Status is not valid.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'Specified instance does not exist or not support.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2875D608-A228-53D7-B8C9-35F13EDCF36D\\",\\n \\"SlotName\\": \\"slot_test01\\"\\n}","type":"json"}]', 'title' => 'DeleteSlot', 'description' => '### [](#)Supported database engine'."\n" ."\n" .'* PostgreSQL'."\n" ."\n" .'### [](#)Precautions'."\n" ."\n" .'You can delete a replication slot only when the status of the slot is **INACTIVE**. You can call the DescribeSlots operation to query the status of a replication slot.'."\n", ], 'DescribeSlots' => [ 'summary' => 'Queries all replication slots of an instance.', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request.'."\n" ."\n" .'You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOC****', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'pgm-bp102g323jd4****', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The resource group ID. You can leave this parameter empty.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy*****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '76AF0609-4195-5DFC-BC78-3AD76FF872BB', ], 'Slots' => [ 'description' => 'The information about the replication slot.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The object of the replication slot.'."\n", 'type' => 'object', 'properties' => [ 'Database' => [ 'description' => 'The name of the database in which the replication slot resides.'."\n", 'type' => 'string', 'example' => 'db_test01', ], 'Plugin' => [ 'description' => 'The extension used by the replication slot.'."\n", 'type' => 'string', 'enumValueTitles' => [], 'example' => 'test_decoding', ], 'SlotName' => [ 'description' => 'The replication slot name.'."\n", 'type' => 'string', 'example' => 'slot_test01', ], 'SlotStatus' => [ 'description' => 'The replication slot status. Valid values:'."\n" ."\n" .'* ACTIVE'."\n" .'* INACTIVE'."\n", 'type' => 'string', 'enumValueTitles' => [], 'example' => 'INACTIVE', ], 'SlotType' => [ 'description' => 'The replication slot type. Valid values:'."\n" ."\n" .'* physical'."\n" .'* logical'."\n", 'type' => 'string', 'enumValueTitles' => [], 'example' => 'logical', ], 'SubReplayLag' => [ 'description' => 'The latency of the logical subscription on the subscriber node that corresponds to the current replication slot. Unit: seconds.'."\n", 'type' => 'string', 'example' => '0', ], 'Temporary' => [ 'description' => 'Indicates whether the replication slot is a temporary replication slot. Valid values:'."\n" ."\n" .'* true'."\n" .'* false'."\n", 'type' => 'string', 'enumValueTitles' => [], 'example' => 'false', ], 'WalDelay' => [ 'description' => 'The number of logs accumulated in the replication slot.'."\n", 'type' => 'string', 'example' => '16 MB', ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The specified DB instance name does not exist.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"76AF0609-4195-5DFC-BC78-3AD76FF872BB\\",\\n \\"Slots\\": [\\n {\\n \\"Database\\": \\"db_test01\\",\\n \\"Plugin\\": \\"test_decoding\\",\\n \\"SlotName\\": \\"slot_test01\\",\\n \\"SlotStatus\\": \\"INACTIVE\\",\\n \\"SlotType\\": \\"logical\\",\\n \\"SubReplayLag\\": \\"0\\",\\n \\"Temporary\\": \\"false\\",\\n \\"WalDelay\\": \\"16 MB\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => 'DescribeSlots', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* PostgreSQL'."\n", ], 'CreateReplicationLink' => [ 'summary' => 'Creates a data synchronization task for a disaster recovery (DR) ApsaraDB RDS instance.', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the DR instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pgm-bp1trqb4p1xd****'."\n", ], ], [ 'name' => 'DryRun', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to perform a dry run before the system creates the DR instance. Valid values:'."\n" ."\n" .'* **true**: performs a dry run but does not create the instance. The system checks the request parameters, request syntax, limits, and available resources.'."\n" .'* **false** (default): performs a dry run and the actual request. If the request passes the dry run, the instance is directly created.'."\n", 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'false', ], ], [ 'name' => 'SourceAddress', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => [ 'description' => 'The endpoint of the source ApsaraDB RDS for PostgreSQL instance or the IP address of the source ApsaraDB RDS for SQL Server instance.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'pgm-****.pg.rds.aliyuncs.com', ], ], [ 'name' => 'SourcePort', 'in' => 'query', 'schema' => [ 'description' => 'The port of the source instance.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '5432', ], ], [ 'name' => 'ReplicatorAccount', 'in' => 'query', 'schema' => [ 'description' => 'The account of the database that is used for data synchronization.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'testdbuser', ], ], [ 'name' => 'ReplicatorPassword', 'in' => 'query', 'schema' => [ 'description' => 'The password of the account.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'testpassword', ], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'description' => 'The task ID of the successful dry run.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '439946016', ], ], [ 'name' => 'SourceCategory', 'in' => 'query', 'schema' => [ 'description' => 'The type of the source instance. Valid values:'."\n" ."\n" .'* **other**: other instances. **SQL Server instances are not supported.**'."\n" .'* **aliyunRDS**: an ApsaraDB RDS instance.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'enumValueTitles' => [ 'other' => '', 'aliyunRDS' => '', ], 'example' => 'aliyunRDS', ], ], [ 'name' => 'SourceInstanceRegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the source instance. If you set **SourceCategory** to **aliyunRDS**, this parameter is required.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'SourceInstanceName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the source instance. If you set **SourceCategory** to **aliyunRDS**, this parameter is required.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'testInstance', ], ], [ 'name' => 'TaskName', 'in' => 'query', 'schema' => [ 'description' => 'The task name of the dry run. You can specify a custom task name. If you do not specify this parameter, ApsaraDB RDS automatically generates a task name.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'test01', ], ], [ 'name' => 'TargetAddress', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => [ 'description' => 'The IP address of the DR instance of the ApsaraDB RDS for SQL Server instance.', 'type' => 'string', 'required' => false, 'example' => '192.XXX.XX.XXX', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'DBInstanceId' => [ 'description' => 'The ID of the DR instance.'."\n", 'type' => 'string', 'example' => 'pgm-****.pg.rds.aliyuncs.com', ], 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '9F8C06AD-3F37-57A0-ABBF-ABD7824F55CE', ], 'TaskId' => [ 'description' => 'The task ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '564532302', ], 'TaskName' => [ 'description' => 'The task name.'."\n", 'type' => 'string', 'example' => 'test01', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'The current instance state does not support this operation.', ], [ 'errorCode' => 'InvalidSourceCategory', 'errorMessage' => 'specified source category is invalid.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'InvalidTaskId.Format', 'errorMessage' => 'The parameter TaskId is required.', ], ], 403 => [ [ 'errorCode' => 'IncorrectDBInstance', 'errorMessage' => 'The current DB instance does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'The database instance type does not support the operation.', ], [ 'errorCode' => 'ENDPOINT_NOT_FOUND', 'errorMessage' => 'The source address %s must be the endpoint of source instance %s.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', ], [ 'errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DBInstanceId\\": \\"PostgreSQL：pgm-****.pg.rds.aliyuncs.com\\\\nSQL Server：92****\\",\\n \\"RequestId\\": \\"442FC501-C4DD-1349-B70A-DE13D189072E\\",\\n \\"TaskId\\": 0,\\n \\"TaskName\\": \\"zbtest\\"\\n}","type":"json"}]', 'title' => 'CreateReplicationLink', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" ."\n" .'> The parameters vary based on database engines.'."\n", ], 'DescribeReplicationLinkLogs' => [ 'summary' => 'Queries the operation logs of the data synchronization task for a specified ApsaraDB RDS instance.', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pgm-bp1trqb4p1xd****'."\n", ], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'description' => 'The task ID. You must set this parameter to the ID of the task that you create by calling the **CreateReplicationLink** operation for the disaster recovery instance.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '8413252', ], ], [ 'name' => 'TaskName', 'in' => 'query', 'schema' => [ 'description' => 'The task name. You must set this parameter to the name of the task that you create by calling the **CreateReplicationLink** operation for the disaster recovery instance.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'test01', ], ], [ 'name' => 'TaskType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the task. Valid values:'."\n" ."\n" .'* **create**: creates a synchronization link.'."\n" .'* **create-dryrun**: performs a precheck before a synchronization link is created.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'* create: creates a replication link.'."\n" .'* create-dryrun: performs a precheck before a replication link is created.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'enumValueTitles' => [ 'create' => '', 'create-dryrun' => '', ], 'example' => 'create', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '30', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'DBInstanceId' => [ 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'pgm-bp1trqb4p1xd****', ], 'Items' => [ 'description' => 'The items.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details of the item.'."\n", 'type' => 'object', 'properties' => [ 'Detail' => [ 'description' => 'The details of the task.'."\n", 'type' => 'string', 'example' => '[Check rds empty]\\nCheck rds databases: success\\n[Check source connectivity]\\nCheck ip connectable: success\\nCheck port connectable: success\\nCheck database connectable: success\\nCheck account replication privilege: success\\nCheck account createrole privilege: success\\nCheck account monitor privilege: success\\n[Check source version]\\nCheck major version consistent: success\\n[Check source glibc version]\\nCheck source glibc version compatible: warning(warning:source glibc version is not compatible with rds pg)\\n[Check disk size]\\nCheck disk size enough: success\\n[Check wal keep size]\\nCheck wal keep size large enough: success\\n[Check spec params]\\nCheck if spec params too large: success\\n [Check triggers]\\nCheck triggers compatible: success\\n[Check user functions]\\nCheck user functions compatible: success\\n*Migrate check success*', ], 'GmtCreated' => [ 'description' => 'The creation time. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2022-02-25T06:57:41Z', ], 'GmtModified' => [ 'description' => 'The modification time. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2022-03-01T06:39:51Z', ], 'ReplicationInfo' => [ 'description' => 'The synchronization information. This parameter is a reserved parameter.'."\n", 'type' => 'string', 'example' => 'None', ], 'ReplicationState' => [ 'description' => 'The status of the synchronization. Valid values:'."\n" ."\n" .'* **steaming**: The synchronization is in progress.'."\n" .'* **finish**: The synchronization is complete.'."\n" .'* **disconnect**: The synchronization is disconnected.'."\n", 'type' => 'string', 'example' => 'finish', ], 'ReplicatorAccount' => [ 'description' => 'The account of the database that is used for data synchronization.'."\n", 'type' => 'string', 'example' => 'testdbuser'."\n", ], 'ReplicatorPassword' => [ 'description' => 'The password of the account.'."\n", 'type' => 'string', 'example' => 'testpassword'."\n", ], 'SourceAddress' => [ 'description' => 'The endpoint of the source instance.'."\n", 'type' => 'string', 'example' => 'pgm-****.pg.rds.aliyuncs.com'."\n", ], 'SourceCategory' => [ 'description' => 'The type of the source instance. Valid values:'."\n" ."\n" .'* other: other instances'."\n" .'* aliyunRDS: an ApsaraDB RDS instance'."\n", 'type' => 'string', 'example' => 'aliyunRDS', ], 'SourcePort' => [ 'description' => 'The port number of the source instance.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '5432', ], 'TargetInstanceId' => [ 'description' => 'The destination instance ID.'."\n", 'type' => 'string', 'example' => 'pgm-bp1l4dutw453****', ], 'TaskId' => [ 'description' => 'The ID of the task.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '8413252', ], 'TaskName' => [ 'description' => 'The name of the task.'."\n", 'type' => 'string', 'example' => 'test01', ], 'TaskStage' => [ 'description' => 'The stage of the task. Valid values:'."\n" ."\n" .'* **precheck**: the precheck stage.'."\n" .'* **basebackup**: the basic backup stage.'."\n" .'* **startup**: the startup stage.'."\n" .'* **increment**: the incremental synchronization stage.'."\n", 'type' => 'string', 'example' => 'increment', ], 'TaskStatus' => [ 'description' => 'The status of the task. Valid values:'."\n" ."\n" .'* **success**'."\n" .'* **failure**'."\n" .'* **running**'."\n", 'type' => 'string', 'example' => 'success ', ], 'TaskType' => [ 'description' => 'The type of the task. Valid values:'."\n" ."\n" .'* **create**: creates a synchronization link.'."\n" .'* **create-dryrun**: performs a precheck before a synchronization link is created.'."\n", 'type' => 'string', 'example' => 'create', ], ], ], ], 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '16C62438-491B-5C02-9B49-BA924A1372A2', ], 'TotalSize' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidTaskType', 'errorMessage' => 'specified task type is invalid.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DBInstanceId\\": \\"pgm-bp1trqb4p1xd****\\",\\n \\"Items\\": [\\n {\\n \\"Detail\\": \\"[Check rds empty]\\\\\\\\nCheck rds databases: success\\\\\\\\n[Check source connectivity]\\\\\\\\nCheck ip connectable: success\\\\\\\\nCheck port connectable: success\\\\\\\\nCheck database connectable: success\\\\\\\\nCheck account replication privilege: success\\\\\\\\nCheck account createrole privilege: success\\\\\\\\nCheck account monitor privilege: success\\\\\\\\n[Check source version]\\\\\\\\nCheck major version consistent: success\\\\\\\\n[Check source glibc version]\\\\\\\\nCheck source glibc version compatible: warning(warning:source glibc version is not compatible with rds pg)\\\\\\\\n[Check disk size]\\\\\\\\nCheck disk size enough: success\\\\\\\\n[Check wal keep size]\\\\\\\\nCheck wal keep size large enough: success\\\\\\\\n[Check spec params]\\\\\\\\nCheck if spec params too large: success\\\\\\\\n [Check triggers]\\\\\\\\nCheck triggers compatible: success\\\\\\\\n[Check user functions]\\\\\\\\nCheck user functions compatible: success\\\\\\\\n*Migrate check success*\\",\\n \\"GmtCreated\\": \\"2022-02-25T06:57:41Z\\",\\n \\"GmtModified\\": \\"2022-03-01T06:39:51Z\\",\\n \\"ReplicationInfo\\": \\"None\\",\\n \\"ReplicationState\\": \\"finish\\",\\n \\"ReplicatorAccount\\": \\"testdbuser\\\\n\\",\\n \\"ReplicatorPassword\\": \\"testpassword\\\\n\\",\\n \\"SourceAddress\\": \\"pgm-****.pg.rds.aliyuncs.com\\\\n\\",\\n \\"SourceCategory\\": \\"aliyunRDS\\",\\n \\"SourcePort\\": 5432,\\n \\"TargetInstanceId\\": \\"pgm-bp1l4dutw453****\\",\\n \\"TaskId\\": 8413252,\\n \\"TaskName\\": \\"test01\\",\\n \\"TaskStage\\": \\"increment\\",\\n \\"TaskStatus\\": \\"success \\",\\n \\"TaskType\\": \\"create\\"\\n }\\n ],\\n \\"RequestId\\": \\"16C62438-491B-5C02-9B49-BA924A1372A2\\",\\n \\"TotalSize\\": 1\\n}","type":"json"}]', 'title' => 'DescribeReplicationLinkLogs', 'description' => '### [](#)Supported database engine'."\n" ."\n" .'* PostgreSQL'."\n", ], 'RebuildReplicationLink' => [ 'summary' => 'Re-creates a data synchronization link for a disaster recovery ApsaraDB RDS instance.', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pgm-bp1trqb4p1xd****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'DBInstanceId' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'pgm-bp1trqb4p1xd****', ], 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '65BDA532-28AF-4122-AA39-B382721EEE64', ], 'TaskId' => [ 'description' => 'The task ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '3472****', ], 'TaskName' => [ 'description' => 'The task name.'."\n", 'type' => 'string', 'example' => 'test01', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'The current instance state does not support this operation.', ], [ 'errorCode' => 'InvalidSourceCategory', 'errorMessage' => 'specified source category is invalid.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'IncorrectDBInstance', 'errorMessage' => 'The current DB instance does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'The database instance type does not support the operation.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', ], [ 'errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DBInstanceId\\": \\"pgm-bp1trqb4p1xd****\\",\\n \\"RequestId\\": \\"65BDA532-28AF-4122-AA39-B382721EEE64\\",\\n \\"TaskId\\": 0,\\n \\"TaskName\\": \\"test01\\"\\n}","type":"json"}]', 'title' => 'RebuildReplicationLink', 'description' => '### [](#)Supported database engine'."\n" ."\n" .'* PostgreSQL'."\n", ], 'SwitchReplicationLink' => [ 'summary' => 'Switches the data synchronization link from a the primary ApsaraDB RDS for SQL Server instance to a disaster recovery (DR) instance.', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the source or primary instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-2zecuz9tolf******', ], ], [ 'name' => 'TargetInstanceName', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => [ 'description' => 'The name of the destination DR instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-t4neh0q12v1******', ], ], [ 'name' => 'TargetInstanceRegionId', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => [ 'description' => 'The ID of the region in which the destination DR instance resides.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ap-southeast-1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'DBInstanceId' => [ 'description' => 'The ID of the DR instance.'."\n", 'type' => 'string', 'example' => '135****', ], 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '2F2DD69B-90AF-1E72-923C-87575658A9D9', ], 'TaskId' => [ 'description' => 'The task ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '159****', ], 'TaskName' => [ 'description' => 'The task name.'."\n", 'type' => 'string', 'example' => 'zbtest', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'NoAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for account. We recommend that you add a payment method.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DBInstanceId\\": \\"135****\\",\\n \\"RequestId\\": \\"2F2DD69B-90AF-1E72-923C-87575658A9D9\\",\\n \\"TaskId\\": 0,\\n \\"TaskName\\": \\"zbtest\\"\\n}","type":"json"}]', 'title' => 'SwitchReplicationLink', 'description' => '### [](#)Supported database engine'."\n" ."\n" .'SQL Server'."\n", ], 'DeleteReplicationLink' => [ 'summary' => 'Deletes the data synchronization link for a disaster recovery (DR) ApsaraDB RDS instance and promotes the DR instance to the primary instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the DR instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pgm-bp1trqb4p1xd****'."\n", ], ], [ 'name' => 'PromoteToMaster', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to delete the data synchronization link between the DR instance and the primary instance and promote the DR instance to the primary instance. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'true', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'DBInstanceId' => [ 'description' => 'The ID of the DR instance.'."\n", 'type' => 'string', 'example' => 'pgm-bp1trqb4p1xd****', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '847BA085-B377-4BFA-8267-F82345ECE1D2', ], 'TaskId' => [ 'description' => 'The task ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '3472****'."\n", ], 'TaskName' => [ 'description' => 'The task name.'."\n", 'type' => 'string', 'example' => 'test01', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'The current instance state does not support this operation.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'Cloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], ], 403 => [ [ 'errorCode' => 'IncorrectDBInstance', 'errorMessage' => 'The current DB instance does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'The database instance type does not support the operation.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', ], [ 'errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DBInstanceId\\": \\"PostgreSQL：pgm-bp1trqb4p1******\\\\nSQL Server：135****\\",\\n \\"RequestId\\": \\"1EFCFB59-7152-19C4-8C53-F887D107AFD3\\",\\n \\"TaskId\\": 0,\\n \\"TaskName\\": \\"zbtest\\"\\n}","type":"json"}]', 'title' => 'DeleteReplicationLink', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n", ], 'ModifyComputeBurstConfig' => [ 'summary' => 'Modifies the settings of assured serverless or disables assured serverless.', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of requests and prevent repeated requests from being submitted. You can use the client to generate the value, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCziJZNwH****', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'pgm-2ze63v2p3o3k****', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy****', ], ], [ 'name' => 'SwitchTimeMode', 'in' => 'query', 'schema' => [ 'description' => 'The effective policy. Valid values:'."\n" ."\n" .'* **0**: Immediately takes effect.'."\n" .'* **1**: Takes effect within the maintenance window. You can call the **ModifyDBInstanceMaintainTime** operation to change the maintenance window of an instance.'."\n" .'* **2**: Takes effect at a specified point in time.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Immediate', ], ], [ 'name' => 'SwitchTime', 'in' => 'query', 'schema' => [ 'description' => 'The time when the specified entry takes effect. The time follows the ISO 8601 standard in the `yyyy-MM-ddTHH:mm:ssZ` format. The time is displayed in UTC.'."\n" ."\n" .'> This parameter is required only if **SwitchTimeMode** is set to **2**.'."\n", 'type' => 'string', 'required' => false, 'example' => '2025-05-06T09:24:00Z', ], ], [ 'name' => 'ScaleMaxCpus', 'in' => 'query', 'schema' => [ 'description' => 'The maximum number of CPU cores for elastic scaling. The maximum value cannot exceed twice the initial CPU configuration.'."\n", 'type' => 'string', 'required' => false, 'example' => '2', ], ], [ 'name' => 'ScaleMaxMemory', 'in' => 'query', 'schema' => [ 'description' => 'The maximum memory for elastic scaling. The value cannot exceed twice the instance\'s initial memory size. Unit: GB. Step size: 2 GB.'."\n", 'type' => 'string', 'required' => false, 'example' => '4', ], ], [ 'name' => 'CpuShrinkThreshold', 'in' => 'query', 'schema' => [ 'description' => 'The CPU utilization threshold for **scale-in**. Valid values: 30 to 55. Unit: %.'."\n", 'type' => 'string', 'required' => false, 'example' => '50', ], ], [ 'name' => 'CpuEnlargeThreshold', 'in' => 'query', 'schema' => [ 'description' => 'The CPU utilization threshold for **scale-out**. Valid values: 60 to 90. Unit: %.'."\n", 'type' => 'string', 'required' => false, 'example' => '80', ], ], [ 'name' => 'MemoryShrinkThreshold', 'in' => 'query', 'schema' => [ 'description' => 'The memory usage threshold for **scale-in**. Valid values: 30 to 55. Unit: %.'."\n", 'type' => 'string', 'required' => false, 'example' => '50', ], ], [ 'name' => 'MemoryEnlargeThreshold', 'in' => 'query', 'schema' => [ 'description' => 'The memory usage threshold for **scale-out**. Valid values: 60 to 90. Unit: %.'."\n", 'type' => 'string', 'required' => false, 'example' => '80', ], ], [ 'name' => 'BurstStatus', 'in' => 'query', 'schema' => [ 'description' => 'This parameter is set to **disabled** if the assured serverless feature is disabled.'."\n", 'type' => 'string', 'required' => false, 'example' => 'disabled', ], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'description' => 'The reserved parameter. This parameter is not supported.'."\n", 'type' => 'string', 'required' => false, 'example' => 'None', ], ], [ 'name' => 'CrontabJobId', 'in' => 'query', 'schema' => [ 'description' => 'The reserved parameter. This parameter is not supported.'."\n", 'type' => 'string', 'required' => false, 'example' => 'None', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'C816A4BF-A6EC-4722-95F9-2055859CCFD2', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'Specified parameters is not valid.', ], [ 'errorCode' => 'BurstResourceStillExists', 'errorMessage' => 'The instance does not support to disable compute burst because of having burst resource.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'NoAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for account. We recommend that you add a payment method.', ], [ 'errorCode' => 'IncorrectEngineVersion', 'errorMessage' => 'Current engine version does not support operations.', ], ], 403 => [ [ 'errorCode' => 'IncorrectDBInstance', 'errorMessage' => 'The current DB instance does not support this operation.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C816A4BF-A6EC-4722-95F9-2055859CCFD2\\"\\n}","type":"json"}]', 'title' => 'ModifyComputeBurstConfig', 'description' => '### [](#)Supported database engine'."\n" ."\n" .'RDS PostgreSQL'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'[Assured serverless](~~2928780~~)'."\n", ], 'DescribeComputeBurstConfig' => [ 'summary' => 'Queries the settings of assured serverless.', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of requests and prevent repeated requests from being submitted. You can use the client to generate the value, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxxxxx', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'pgm-2ze63v2p3o3k****', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy*****', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the region in which the instance resides.'."\n", 'type' => 'string', 'format' => 'byte', 'required' => false, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'ComputeBurstEnabled' => [ 'description' => 'Indicates whether the assured serverless feature is enabled. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'ComputeBurstConfig' => [ 'description' => 'The detailed configurations of the assured serverless feature.'."\n", 'type' => 'object', 'example' => '{'."\n" .' "cpuEnlargeThreshold": "60",'."\n" .' "memoryEnlargeThreshold": "60",'."\n" .' "scaleMaxMemory": "4",'."\n" .' "memoryShrinkThreshold": "50",'."\n" .' "scaleMaxCpus": "2",'."\n" .' "cpuShrinkThreshold": "30"'."\n" .' }', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '847BA085-B377-4BFA-8267-F82345ECE1D2', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'NoAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for account. We recommend that you add a payment method.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ComputeBurstEnabled\\": true,\\n \\"ComputeBurstConfig\\": {\\n \\"cpuEnlargeThreshold\\": \\"60\\",\\n \\"memoryEnlargeThreshold\\": \\"60\\",\\n \\"scaleMaxMemory\\": \\"4\\",\\n \\"memoryShrinkThreshold\\": \\"50\\",\\n \\"scaleMaxCpus\\": \\"2\\",\\n \\"cpuShrinkThreshold\\": \\"30\\"\\n },\\n \\"RequestId\\": \\"847BA085-B377-4BFA-8267-F82345ECE1D2\\"\\n}","type":"json"}]', 'title' => 'DescribeComputeBurstConfig', 'description' => '### [](#)Supported database engine'."\n" ."\n" .'RDS PostgreSQL'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'[Assured serverless](~~2928780~~)'."\n", ], 'CreateSecret' => [ 'summary' => 'Creates a credential for a user who uses the Data API feature.', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the generated token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCz*****', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the instance. You can call the DescribeDBInstanceAttribute operation to query the region ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'Username', 'in' => 'query', 'schema' => [ 'description' => 'The username that is used to access the database.'."\n", 'type' => 'string', 'required' => true, 'example' => 'user_jack', ], ], [ 'name' => 'Password', 'in' => 'query', 'schema' => [ 'description' => 'The password that is used to access the database.'."\n", 'type' => 'string', 'required' => true, 'example' => '12345678', ], ], [ 'name' => 'DbInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the instance. You can call the DescribeDBInstances operation to query the ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-sdfljk123***', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the resource group to which the instance belongs. You can call the DescribeDBInstanceAttribute operation to query the ID of the resource group.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rg-acfmxypivk***', ], ], [ 'name' => 'DbNames', 'in' => 'query', 'schema' => [ 'description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => false, 'example' => 'users', ], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => [ 'description' => 'The description of the credential.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', ], ], [ 'name' => 'SecretName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the credential.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Foo', ], ], [ 'name' => 'Engine', 'in' => 'query', 'schema' => [ 'description' => 'The engine of the database.'."\n" ."\n" .'> Only MySQL is supported.'."\n", 'type' => 'string', 'required' => true, 'example' => 'MySQL', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'DF4961DD-16F5-5B24-BD4C-0C7788F7ADAF', ], 'SecretArn' => [ 'description' => 'The Alibaba Cloud Resource Name (ARN) of the credential for the created Data API account.'."\n", 'type' => 'string', 'example' => 'acs:rds:cn-hangzhou:1335786***:dbInstance/rm-bp1m7l3j63****', ], 'SecretName' => [ 'description' => 'The name of the credential.'."\n", 'type' => 'string', 'example' => 'Foo', ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**: The request was successful.'."\n" .'* **false**: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'Specified parameters is not valid.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'Invalid DBInstanceId NotFound.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"DF4961DD-16F5-5B24-BD4C-0C7788F7ADAF\\",\\n \\"SecretArn\\": \\"acs:rds:cn-hangzhou:1335786****:dbInstance/rm-bp1m7l3j63****\\",\\n \\"SecretName\\": \\"Foo\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n DF4961DD-16F5-5B24-BD4C-0C7788F7ADAF\\n true\\n acs:rds:cn-hangzhou:1335786***:dbInstance/rm-bp1m7l3j63****\\n Foo\\n","errorExample":""}]', 'title' => 'CreateSecret', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n", ], 'DeleteSecret' => [ 'summary' => 'Deletes the credential of a user who uses the Data API feature.', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCz*****', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the DescribeSecrets operation to query the region ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'SecretArn', 'in' => 'query', 'schema' => [ 'description' => 'The Alibaba Cloud Resource Name (ARN) of the credential for the created Data API account. You can call the CreateSecret operation to obtain the value of this parameter.'."\n" ."\n" .'> You must specify one of the SecretArn and **SecretName** parameters.'."\n", 'type' => 'string', 'required' => false, 'example' => 'acs:rds:cn-hangzhou:1335786***:dbInstance/rm-bp1m7l3j63****', ], ], [ 'name' => 'SecretName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the credential.'."\n" ."\n" .'> * You must specify one of **SecretArn** and SecretName.'."\n" .'> * If you specify this parameter, you must also specify **DbInstanceId**.', 'type' => 'string', 'required' => false, 'example' => 'Foo', ], ], [ 'name' => 'Engine', 'in' => 'query', 'schema' => [ 'description' => 'The engine of the database.'."\n" ."\n" .'> Only MySQL is supported.'."\n", 'type' => 'string', 'required' => true, 'example' => 'MySQL', ], ], [ 'name' => 'DbInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n" ."\n" .'> If you specify this parameter, you must also specify the **SecretName** parameter. parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rm-sfjdlsjxxxxx', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The resource group ID. You can call the DescribeDBInstanceAttribute operation to query the resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'DF4961DD-16F5-5B24-BD4C-0C7788F7ADAF', ], 'SecretArn' => [ 'description' => 'The ARN of the credential for the Data API account.'."\n", 'type' => 'string', 'example' => 'acs:rds:cn-hangzhou:1335786***:dbInstance/rm-bp1m7l3j63****', ], 'SecretName' => [ 'description' => 'The name of the credential.'."\n", 'type' => 'string', 'example' => 'Foo', ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'SecretNotFound', 'errorMessage' => 'Specified rds data api secret is not found', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"DF4961DD-16F5-5B24-BD4C-0C7788F7ADAF\\",\\n \\"SecretArn\\": \\"acs:rds:cn-hangzhou:1335786***:dbInstance/rm-bp1m7l3j63****\\",\\n \\"SecretName\\": \\"Foo\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n DF4961DD-16F5-5B24-BD4C-0C7788F7ADAF\\n true\\n acs:rds:cn-hangzhou:1335786***:dbInstance/rm-bp1m7l3j63****\\n Foo\\n","errorExample":""}]', 'title' => 'DeleteSecret', ], 'DescribeSecrets' => [ 'summary' => 'Queries the credential of a user who uses the Data API feature.', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCz*****', ], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', 'schema' => [ 'description' => 'The language of the text within the response. Valid values:'."\n" ."\n" .'* **zh-CN**: Chinese'."\n" .'* **en-US**: English'."\n" ."\n" .'> The default value is **en-US**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'en-US', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the DescribeDBInstanceAttribute operation to query the region ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'DbInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rm-xjkljjxxxxx', ], ], [ 'name' => 'Engine', 'in' => 'query', 'schema' => [ 'description' => 'The database engine of the database.'."\n" ."\n" .'> Only MySQL is supported.'."\n", 'type' => 'string', 'required' => true, 'example' => 'MySQL', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return. Valid values: any non-zero positive integer.'."\n" ."\n" .'> The default value is 1.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the resource group to which the instance belongs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmxypivk***', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'PageNumber' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10', ], 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'DF4961DD-16F5-5B24-BD4C-0C7788F7ADAF', ], 'Secrets' => [ 'description' => 'The details of the credential.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details about the credential.'."\n", 'type' => 'object', 'properties' => [ 'AccountId' => [ 'description' => 'The ID of the Alibaba Cloud account.'."\n", 'type' => 'string', 'example' => '1266348003******', ], 'Description' => [ 'description' => 'The description of the credential.'."\n", 'type' => 'string', 'example' => 'test', ], 'RegionId' => [ 'description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], 'SecretArn' => [ 'description' => 'The Alibaba Cloud Resource Name (ARN) of the credential for the created Data API account.'."\n", 'type' => 'string', 'example' => 'acs:rds:cn-hangzhou:1335786***:dbInstance/rm-bp1m7l3j63****', ], 'SecretName' => [ 'description' => 'The name of the credential.'."\n", 'type' => 'string', 'example' => 'Foo', ], 'Username' => [ 'description' => 'The username that is used to access the database.'."\n", 'type' => 'string', 'example' => 'user_jack', ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"DF4961DD-16F5-5B24-BD4C-0C7788F7ADAF\\",\\n \\"Secrets\\": [\\n {\\n \\"AccountId\\": \\"1266348003****\\",\\n \\"Description\\": \\"test\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"SecretArn\\": \\"acs:rds:cn-hangzhou:1335786****:dbInstance/rm-bp1m7l3j63****\\",\\n \\"SecretName\\": \\"Foo\\",\\n \\"Username\\": \\"user_jack\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n DF4961DD-16F5-5B24-BD4C-0C7788F7ADAF\\n 10\\n 1\\n \\n Foo\\n cn-hangzhou\\n acs:rds:cn-hangzhou:1335786***:dbInstance/rm-bp1m7l3j63****\\n \\n","errorExample":""}]', 'title' => 'DescribeSecrets', 'description' => '### [](#)Supported database engine'."\n" ."\n" .'* MySQL'."\n", ], 'DescribeDedicatedHostGroups' => [ 'summary' => 'Queries information about an ApsaraDB MyBase dedicated cluster.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'DedicatedHostGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The dedicated cluster ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'dhg-7a9xxxxxxxx', ], ], [ 'name' => 'ImageCategory', 'in' => 'query', 'schema' => [ 'description' => 'The image based on which the hosts in the dedicated clusters are created. Valid values:'."\n" ."\n" .'* **WindowsWithMssqlStdLicense**: a Windows image that contains the licenses of SQL Server Standard Edition'."\n" .'* **WindowsWithMssqlEntLisence**: a Windows image that contains the licenses of SQL Server Enterprise Edition'."\n" .'* **WindowsWithMssqlWebLisence**: a Windows image that contains the licenses of SQL Server Web Edition'."\n" .'* **AliLinux**: a Linux image'."\n", 'type' => 'string', 'required' => false, 'example' => 'WindowsWithMssqlStdLicense', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'DedicatedHostGroups' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'DedicatedHostGroups' => [ 'description' => 'The information about dedicated clusters returned.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'AllocationPolicy' => [ 'description' => 'The policy based on which the system allocates resources in the dedicated cluster. Valid values:'."\n" ."\n" .'* **Evenly**: The system evenly allocates the resources to all the hosts in the dedicated cluster.'."\n" .'* **Intensively**: The system preferentially allocates the resources to the heavily loaded hosts in the dedicated cluster.'."\n", 'type' => 'string', 'example' => 'Evenly', ], 'BastionInstanceId' => [ 'description' => 'The ID of the bastion host.'."\n", 'type' => 'string', 'example' => 'bastionhost-cn-m7xxxxxxxx', ], 'CpuAllocateRation' => [ 'description' => 'The percentage of allocated cores in the dedicated cluster. Unit: %.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '25', ], 'CpuAllocatedAmount' => [ 'description' => 'The number of allocated cores in the dedicated cluster.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '8', ], 'CpuAllocationRatio' => [ 'description' => 'The core overcommitment ratio of the dedicated cluster. Unit: %. For more information about the core overcommitment ratio, see [Manage a dedicated cluster](~~182328~~).'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'CreateTime' => [ 'description' => 'The timestamp when the dedicated cluster was created.'."\n", 'type' => 'string', 'example' => '1571125370000', ], 'DedicatedHostCountGroupByHostType' => [ 'description' => 'The type of storage media that is used for the hosts in the dedicated cluster. Valid values:'."\n" ."\n" .'* **dhg_cloud_ssd**: cloud disks'."\n" .'* **dhg_local_ssd**: local disks'."\n", 'type' => 'object', 'example' => 'dhg_cloud_ssd', ], 'DedicatedHostGroupDesc' => [ 'description' => 'The name of the dedicated cluster.'."\n", 'type' => 'string', 'example' => 'testHostGroup', ], 'DedicatedHostGroupId' => [ 'description' => 'The ID of the dedicated cluster.'."\n", 'type' => 'string', 'example' => 'dhg-7a9xxxxxxxx', ], 'DiskAllocateRation' => [ 'description' => 'The percentage of allocated disk space in the dedicated cluster. Unit: %.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '0.49', ], 'DiskAllocatedAmount' => [ 'description' => 'The amount of allocated disk space in the dedicated cluster. Unit: GB.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '200', ], 'DiskAllocationRatio' => [ 'description' => 'The disk overcommitment ratio of the dedicated cluster. Unit: %. For more information about the core overcommitment ratio, see [Manage a dedicated cluster](~~182328~~).'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'DiskUsedAmount' => [ 'description' => 'The amount of used disk space in the dedicated cluster. Unit: GB.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '20', ], 'DiskUtility' => [ 'description' => 'The disk usage of the dedicated cluster. Unit: %.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '0', ], 'Engine' => [ 'description' => 'The database engine of the instances in the dedicated cluster.'."\n", 'type' => 'string', 'example' => 'MySQL', ], 'HostNumber' => [ 'description' => 'The total number of hosts in the dedicated cluster.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'HostReplacePolicy' => [ 'description' => 'The policy that is used to handle host failures. Valid values:'."\n" ."\n" .'* **Auto**: The system automatically replaces faulty hosts.'."\n" .'* **Manual**: You must manually replace faulty hosts.'."\n", 'type' => 'string', 'example' => 'Auto', ], 'InstanceNumber' => [ 'description' => 'The total number of instances in the dedicated cluster.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '4', ], 'MemAllocateRation' => [ 'description' => 'The percentage of allocated memory space in the dedicated cluster. Unit: %.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '33.7', ], 'MemAllocatedAmount' => [ 'description' => 'The amount of allocated memory space in the dedicated cluster.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '16384', ], 'MemAllocationRatio' => [ 'description' => 'The memory overcommitment ratio of the dedicated cluster. Unit: %. For more information about the core overcommitment ratio, see [Manage a dedicated cluster](~~182328~~).'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '90', ], 'MemUsedAmount' => [ 'description' => 'The amount of used memory space in the dedicated cluster. Unit: MB.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '0', ], 'MemUtility' => [ 'description' => 'The memory usage of the dedicated cluster. Unit: %.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '0', ], 'OpenPermission' => [ 'description' => 'Indicates whether the feature that allows you to have the OS permissions on the host is enabled. Valid values:'."\n" ."\n" .'* **0** or **null**: The permissions cannot be granted.'."\n" .'* **1**: The permissions can be granted.'."\n" .'* **3**: The permissions have been granted.'."\n", 'type' => 'string', 'example' => '3', ], 'Text' => [ 'description' => 'The name and ID of the dedicated cluster. The value consists of **DedicatedHostGroupDesc** and **DedicatedHostGroupId**. Format: DedicatedHostGroupDesc/DedicatedHostGroupId.'."\n", 'type' => 'string', 'example' => 'testHostGroup/dhg-7a9xxxxxxxx', ], 'VPCId' => [ 'description' => 'The ID of the virtual private cloud (VPC) to which the dedicated cluster belongs.'."\n", 'type' => 'string', 'example' => 'vpc-bp1oxxxxxx', ], 'ZoneIDList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'ZoneIDList' => [ 'description' => 'The zones to which the hosts of the dedicated cluster belong.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The zones to which the hosts of the dedicated cluster belong.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], ], ], ], ], ], ], ], ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'AB44DC0A-7E77-442A-97A9-C6418694CB22', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"DedicatedHostGroups\\": {\\n \\"DedicatedHostGroups\\": [\\n {\\n \\"AllocationPolicy\\": \\"Evenly\\",\\n \\"BastionInstanceId\\": \\"bastionhost-cn-m7xxxxxxxx\\",\\n \\"CpuAllocateRation\\": 25,\\n \\"CpuAllocatedAmount\\": 8,\\n \\"CpuAllocationRatio\\": 200,\\n \\"CreateTime\\": \\"1571125370000\\",\\n \\"DedicatedHostCountGroupByHostType\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"DedicatedHostGroupDesc\\": \\"testHostGroup\\",\\n \\"DedicatedHostGroupId\\": \\"dhg-7a9xxxxxxxx\\",\\n \\"DiskAllocateRation\\": 0.49,\\n \\"DiskAllocatedAmount\\": 200,\\n \\"DiskAllocationRatio\\": 200,\\n \\"DiskUsedAmount\\": 20,\\n \\"DiskUtility\\": 0,\\n \\"Engine\\": \\"MySQL\\",\\n \\"HostNumber\\": 3,\\n \\"HostReplacePolicy\\": \\"Auto\\",\\n \\"InstanceNumber\\": 4,\\n \\"MemAllocateRation\\": 33.7,\\n \\"MemAllocatedAmount\\": 16384,\\n \\"MemAllocationRatio\\": 90,\\n \\"MemUsedAmount\\": 0,\\n \\"MemUtility\\": 0,\\n \\"OpenPermission\\": \\"3\\",\\n \\"Text\\": \\"testHostGroup/dhg-7a9xxxxxxxx\\",\\n \\"VPCId\\": \\"vpc-bp1oxxxxxx\\",\\n \\"ZoneIDList\\": {\\n \\"ZoneIDList\\": [\\n \\"cn-hangzhou\\"\\n ]\\n }\\n }\\n ]\\n },\\n \\"RequestId\\": \\"AB44DC0A-7E77-442A-97A9-C6418694CB22\\"\\n}","errorExample":""},{"type":"xml","example":"\\nAB44DC0A-7E77-442A-97A9-C6418694CB22\\n\\n \\n 200\\n 20\\n 4\\n Evenly\\n Auto\\n dhg-7a9xxxxxxxx\\n bastionhost-cn-m7xxxxxxxx\\n 16384\\n 3\\n 33.7\\n 200\\n MySQL\\n 0\\n 90\\n 25\\n vpc-bp1oxxxxxx\\n 1571125370000\\n testHostGroup/dhg-7a9xxxxxxxx\\n 0\\n testHostGroup\\n 0\\n 200\\n 0.49\\n 3\\n 8\\n dhg_cloud_ssd\\n \\n cn-hangzhou\\n \\n \\n\\n","errorExample":""}]', 'title' => 'DescribeDedicatedHostGroups', 'description' => 'Dedicated clusters allow you to manage a number of instances in a cluster at a time. You can create multiple dedicated clusters in a single region. Each dedicated cluster consists of multiple hosts. You can create multiple instances on each host. For more information, see [What is ApsaraDB MyBase?](~~141455~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeDedicatedHosts' => [ 'summary' => 'Queries the information about the hosts in a dedicated cluster.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'DedicatedHostGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The dedicated cluster ID. You can call the DescribeDedicatedHostGroups operation to query the dedicated cluster ID.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'dhg-7a9xxxxxxxx', ], ], [ 'name' => 'OrderId', 'in' => 'query', 'schema' => [ 'description' => 'The order ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '102565235', ], ], [ 'name' => 'HostType', 'in' => 'query', 'schema' => [ 'description' => 'The storage type of the host. Valid values:'."\n" ."\n" .'* **dhg_cloud_ssd**: enhanced SSD (ESSD)'."\n" .'* **dhg_local_ssd**: local SSD'."\n", 'type' => 'string', 'required' => false, 'example' => 'dhg_cloud_ssd', ], ], [ 'name' => 'HostStatus', 'in' => 'query', 'schema' => [ 'description' => 'The status of the host. Valid values:'."\n" ."\n" .'* **0**: creating'."\n" .'* **1**: running'."\n" .'* **2**: faulty'."\n" .'* **3**: being replaced'."\n" .'* **4**: deprecated'."\n" .'* **5**: deleting'."\n" .'* **6**: restarting'."\n", 'type' => 'string', 'required' => false, 'example' => '1', ], ], [ 'name' => 'AllocationStatus', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether instances can be deployed on the host. Valid values:'."\n" ."\n" .'* **0**: Instances cannot be deployed on the host.'."\n" .'* **1**: Instances can be deployed on the host.'."\n", 'type' => 'string', 'required' => false, 'example' => '1', ], ], [ 'name' => 'ZoneId', 'in' => 'query', 'schema' => [ 'description' => 'The zone ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-i', ], ], [ 'name' => 'DedicatedHostId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the host in the dedicated cluster.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ch-t4nn100ddxxxxxxxx', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'DedicatedHostGroupId' => [ 'description' => 'The host group ID.'."\n", 'type' => 'string', 'example' => 'dhg-7a9xxxxxxxx', ], 'DedicatedHosts' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'DedicatedHosts' => [ 'description' => 'The host information.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'AccountName' => [ 'description' => 'The host account. You can call the [CreateDedicatedHostAccount](~~196877~~) operation to create a host account.'."\n", 'type' => 'string', 'example' => 'test123', ], 'AllocationStatus' => [ 'description' => 'Specifies whether instances can be deployed on the host. Valid values:'."\n" ."\n" .'* **0**: Instances cannot be deployed on the host.'."\n" .'* **1**: Instances can be deployed on the host.'."\n", 'type' => 'string', 'example' => '1', ], 'BastionInstanceId' => [ 'description' => 'The bastion host ID.'."\n", 'type' => 'string', 'example' => 'bastionhost-cn-m7xxxxxxxx', ], 'CPUAllocationRatio' => [ 'description' => 'The core overcommitment ratio of the dedicated cluster. Unit: percentage. For more information about the core overcommitment ratio, see [Manage a dedicated cluster](~~182328~~).'."\n", 'type' => 'string', 'example' => '200', ], 'CpuUsed' => [ 'description' => 'The number of used CPU cores on the host. Unit: cores.'."\n", 'type' => 'string', 'example' => '4', ], 'CreatedTime' => [ 'description' => 'The time when the host was created.'."\n", 'type' => 'string', 'example' => '2021-03-25 17:29:06.0', ], 'DedicatedHostGroupId' => [ 'description' => 'The dedicated cluster ID.'."\n", 'type' => 'string', 'example' => 'dhg-7a9xxxxxxxx', ], 'DedicatedHostId' => [ 'description' => 'The host ID.'."\n", 'type' => 'string', 'example' => 'i-bpxxxxxxx', ], 'DiskAllocationRatio' => [ 'description' => 'The disk overcommitment ratio of the dedicated cluster. Unit: percentage. For more information about the core overcommitment ratio, see [Manage a dedicated cluster](~~182328~~).'."\n", 'type' => 'string', 'example' => '200', ], 'EndTime' => [ 'description' => 'The time when the host expires.'."\n", 'type' => 'string', 'example' => '2021-04-25T16:00:00Z', ], 'Engine' => [ 'description' => 'The database engine of instances that are created on the host.'."\n", 'type' => 'string', 'example' => 'mysql', ], 'HostCPU' => [ 'description' => 'The total number of CPU cores that are configured for the host. Unit: cores.'."\n", 'type' => 'string', 'example' => '8', ], 'HostClass' => [ 'description' => 'The instance type of the host.'."\n", 'type' => 'string', 'example' => 'ecs.i2.16xlarge', ], 'HostMem' => [ 'description' => 'The total memory space of the host. Unit: MB.'."\n", 'type' => 'string', 'example' => '32238', ], 'HostName' => [ 'description' => 'The host name.'."\n", 'type' => 'string', 'example' => 'testHost1', ], 'HostStatus' => [ 'description' => 'The status of the host. Valid values:'."\n" ."\n" .'* **0**: creating'."\n" .'* **1**: running'."\n" .'* **2**: faulty'."\n" .'* **3**: being replaced'."\n" .'* **4**: deprecated'."\n" .'* **5**: deleting'."\n" .'* **6**: restarting'."\n", 'type' => 'string', 'example' => '1', ], 'HostStorage' => [ 'description' => 'The storage capacity of the host. Unit: MB.'."\n", 'type' => 'string', 'example' => '2097152', ], 'HostType' => [ 'description' => 'The storage type of the host. Valid values:'."\n" ."\n" .'* **dhg_cloud_ssd**: ESSD'."\n" .'* **dhg_local_ssd**: local SSD'."\n", 'type' => 'string', 'example' => 'dhg_cloud_ssd', ], 'IPAddress' => [ 'description' => 'The internal IP address of the host.'."\n", 'type' => 'string', 'example' => '192.xx.xx.xx', ], 'ImageCategory' => [ 'description' => 'The host image. This parameter is returned only when the **Engine** parameter is set to **mssql**. Valid values:'."\n" ."\n" .'* **WindowsWithMssqlStdLicense**: a Windows image that contains the licenses of SQL Server Standard Edition'."\n" .'* **WindowsWithMssqlEntLisence**: a Windows image that contains the licenses of SQL Server Enterprise Edition'."\n" .'* **WindowsWithMssqlWebLisence**: a Windows image that contains the licenses of SQL Server Web Edition'."\n", 'type' => 'string', 'example' => 'WindowsWithMssqlStdLicense', ], 'InstanceNumber' => [ 'description' => 'The total number of instances that are created on the host.'."\n", 'type' => 'string', 'example' => '4', ], 'MemAllocationRatio' => [ 'description' => 'The maximum memory usage per host in the dedicated cluster.'."\n", 'type' => 'string', 'example' => '90', ], 'MemoryUsed' => [ 'description' => 'The size of the used memory. Unit: MB.'."\n", 'type' => 'string', 'example' => '16384', ], 'OpenPermission' => [ 'description' => 'Indicates whether the feature that allows you to have the OS permissions on the host is enabled. Valid values:'."\n" ."\n" .'* **0** or **null**: The permissions cannot be granted.'."\n" .'* **1**: The permissions can be granted.'."\n" .'* **3**: The permissions have been granted.'."\n", 'type' => 'string', 'example' => '3', ], 'StorageUsed' => [ 'description' => 'The amount of used storage space on the host.'."\n", 'type' => 'string', 'example' => '0', ], 'VPCId' => [ 'description' => 'The ID of the virtual private cloud (VPC) to which the host belongs.'."\n", 'type' => 'string', 'example' => 'vpc-bpxxxxxxx', ], 'VSwitchId' => [ 'description' => 'The ID of the vSwitch associated with the specified VPC.'."\n", 'type' => 'string', 'example' => 'vsw-bpxxxxxxx', ], 'ZoneId' => [ 'description' => 'The zone ID of the host.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou-i', ], ], ], ], ], ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'C860658E-68A6-46C1-AF6E-3AE7C4D3CACF', ], ], 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidUserId.NotSupport', 'errorMessage' => 'The userid have no permission.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDedicatedHostGroup.NotFound', 'errorMessage' => 'Specified DedicatedHostGroup does not exists.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"DedicatedHostGroupId\\": \\"dhg-7a9xxxxxxxx\\",\\n \\"DedicatedHosts\\": {\\n \\"DedicatedHosts\\": [\\n {\\n \\"AccountName\\": \\"test123\\",\\n \\"AllocationStatus\\": \\"1\\",\\n \\"BastionInstanceId\\": \\"bastionhost-cn-m7xxxxxxxx\\",\\n \\"CPUAllocationRatio\\": \\"200\\",\\n \\"CpuUsed\\": \\"4\\",\\n \\"CreatedTime\\": \\"2021-03-25 17:29:06.0\\",\\n \\"DedicatedHostGroupId\\": \\"dhg-7a9xxxxxxxx\\",\\n \\"DedicatedHostId\\": \\"i-bpxxxxxxx\\",\\n \\"DiskAllocationRatio\\": \\"200\\",\\n \\"EndTime\\": \\"2021-04-25T16:00:00Z\\",\\n \\"Engine\\": \\"mysql\\",\\n \\"HostCPU\\": \\"8\\",\\n \\"HostClass\\": \\"ecs.i2.16xlarge\\",\\n \\"HostMem\\": \\"32238\\",\\n \\"HostName\\": \\"testHost1\\",\\n \\"HostStatus\\": \\"1\\",\\n \\"HostStorage\\": \\"2097152\\",\\n \\"HostType\\": \\"dhg_cloud_ssd\\",\\n \\"IPAddress\\": \\"192.xx.xx.xx\\",\\n \\"ImageCategory\\": \\"WindowsWithMssqlStdLicense\\",\\n \\"InstanceNumber\\": \\"4\\",\\n \\"MemAllocationRatio\\": \\"90\\",\\n \\"MemoryUsed\\": \\"16384\\",\\n \\"OpenPermission\\": \\"3\\",\\n \\"StorageUsed\\": \\"0\\",\\n \\"VPCId\\": \\"vpc-bpxxxxxxx\\",\\n \\"VSwitchId\\": \\"vsw-bpxxxxxxx\\",\\n \\"ZoneId\\": \\"cn-hangzhou-i\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"C860658E-68A6-46C1-AF6E-3AE7C4D3CACF\\"\\n}","errorExample":""},{"type":"xml","example":"\\n \\n \\n 200\\n 200\\n i-bpxxxxxxx\\n 4\\n 2021-03-25 17:29:06.0\\n 2021-04-25T16:00:00Z\\n dhg-7a9xxxxxxxx\\n bastionhost-cn-m7xxxxxxxx\\n WindowsWithMssqlStdLicense\\n 2097152\\n 3\\n dhg_cloud_ssd\\n 32238\\n 16384\\n 1\\n 4\\n mysql\\n testHost1\\n 1\\n cn-hangzhou-i\\n 90\\n vpc-bpxxxxxxx\\n vsw-bpxxxxxxx\\n 0\\n ecs.i2.16xlarge\\n 8\\n 192.xx.xx.xx\\n test123\\n \\n \\n C860658E-68A6-46C1-AF6E-3AE7C4D3CACF\\n dhg-7a9xxxxxxxx\\n","errorExample":""}]', 'title' => 'DescribeDedicatedHosts', 'description' => 'Dedicated clusters allow you to manage a number of instances at a time. You can create multiple dedicated clusters in a single region. Each dedicated cluster consists of multiple hosts. You can create multiple instances on each host. For more information, see [What is ApsaraDB MyBase?](~~141455~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'MigrateDBInstance' => [ 'summary' => 'Migrates an instance across hosts in a dedicated cluster.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'DedicatedHostGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The dedicated cluster ID. You can call the DescribeDedicatedHostGroups operation to query the dedicated cluster ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dhg-4n******', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5******', ], ], [ 'name' => 'TargetDedicatedHostIdForMaster', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the host to which you want to migrate the primary instance. You can call the DescribeDedicatedHosts operation to query the host ID.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'i-bp******', ], ], [ 'name' => 'TargetDedicatedHostIdForSlave', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the host to which you want to migrate the secondary instance. You can call the DescribeDedicatedHosts operation to query the host ID.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'i-bp******', ], ], [ 'name' => 'EffectiveTime', 'in' => 'query', 'schema' => [ 'description' => 'The time when you want the system to start the migration. Valid values:'."\n" ."\n" .'* **Immediately**: The system immediately starts the migration. This is the default value.'."\n" .'* **MaintainTime**: The system starts the migration during the specified maintenance window.'."\n" .'* **Specified**: The system starts the migration at the specified point in time.'."\n", 'type' => 'string', 'required' => false, 'example' => 'MaintainTime', ], ], [ 'name' => 'SpecifiedTime', 'in' => 'query', 'schema' => [ 'description' => 'The point in time when you want the system to start the migration. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time must be in UTC.'."\n" ."\n" .'> This parameter must be specified when you set **EffectiveTime** to **Specified**.'."\n", 'type' => 'string', 'required' => false, 'example' => '2019-10-21T10:00:00Z', ], ], [ 'name' => 'ZoneIdForLog', 'in' => 'query', 'schema' => [ 'description' => 'The zone ID of the logger instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-i', ], ], [ 'name' => 'ZoneIdForFollower', 'in' => 'query', 'schema' => [ 'description' => 'The zone ID of the secondary node.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-h', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'MigrationId' => [ 'description' => 'The serial number of the task in the migration task queue. When the serial number becomes 0, the system starts the migration.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '224****', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '498AE8CA-8C81-4A01-AF37-2B902014ED30', ], 'TaskId' => [ 'description' => 'The task ID.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10824****', ], ], 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'GeneralIns.Creating', 'errorMessage' => 'The general instance is creating.', ], [ 'errorCode' => 'GeneralIns.Maintaining', 'errorMessage' => 'The general instance is maintaining.', ], [ 'errorCode' => 'GeneralIns.Switching', 'errorMessage' => 'The general instance is Switching.', ], [ 'errorCode' => 'InvalidTargetDedicatedHostId.NotFound', 'errorMessage' => 'The target dedicated host ID is invalid.', ], [ 'errorCode' => 'InvalidMasterHostName', 'errorMessage' => 'The specified master host zoneId is different from the master zoneId.', ], [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The specified DB instance name does not exist.', ], [ 'errorCode' => 'InvalidPrimaryCustinsStatus', 'errorMessage' => 'Primary DBInstance status is not Active.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OperationDenied.PrimaryDBInstanceStatus', 'errorMessage' => 'The operation is not permitted due to status of primary instance.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'No host is available for the requested instance.', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'The specified parameter is invalid.', ], [ 'errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance does not exist or is not supported.', ], [ 'errorCode' => 'AllocateResourceFailed', 'errorMessage' => 'Failed to allocate resources. Please check the zone and the host you selected.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"MigrationId\\": 2245016,\\n \\"RequestId\\": \\"498AE8CA-8C81-4A01-AF37-2B902014ED30\\",\\n \\"TaskId\\": 108246861\\n}","errorExample":""},{"type":"xml","example":"\\n2245016\\n498AE8CA-8C81-4A01-AF37-2B902014ED30\\n108246861\\n","errorExample":""}]', 'title' => 'MigrateDBInstance', 'description' => 'Dedicated clusters allow you to manage a number of instances at a time. You can create multiple dedicated clusters in a single region. Each dedicated cluster consists of multiple hosts. You can create multiple instances on each host. For more information, see [What is ApsaraDB MyBase?](~~141455~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'RebuildDBInstance' => [ 'summary' => 'Rebuilds the secondary instance of a primary instance in a dedicated cluster.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'paid', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'DedicatedHostGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The dedicated cluster ID. You can call the DescribeDedicatedHostGroups operation to query the dedicated cluster ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dhg-4nxxxxxxx', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5xxxxxxx', ], ], [ 'name' => 'DedicatedHostId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the host on which the system rebuilds the secondary instance.'."\n" ."\n" .'> If you do not specify this parameter, the system preferentially rebuilds the secondary instance on the original host on which the secondary instance resides. If the remaining storage of the original host is insufficient, the system rebuilds the secondary instance on a host on which the primary instance does not reside. If no suitable hosts are found, the system reports an error that indicates insufficient storage.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'i-bpxxxxxxx', ], ], [ 'name' => 'RebuildNodeType', 'in' => 'query', 'schema' => [ 'description' => 'The role of the secondary instance that you want to rebuild. Valid values:'."\n" ."\n" .'* **FOLLOWER**: secondary instance'."\n" .'* **LOG**: logger instance'."\n", 'type' => 'string', 'required' => false, 'example' => 'FOLLOWER', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'MigrationId' => [ 'description' => 'The serial number of the task in the rebuild task queue. When the serial number becomes 0, the system starts to rebuild the secondary instance.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '329****', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '355DA57C-8CC4-40AB-B3F8-B684BA32EB9E', ], 'TaskId' => [ 'description' => 'The task ID.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20867****', ], ], 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'AtLeastThreeVSwitchAvailableIp', 'errorMessage' => 'The primary vswitch requires at least three available IP addresses.', ], [ 'errorCode' => 'AtLeastTwoVSwitchAvailableIp', 'errorMessage' => 'The primary vswitch requires at least two available IP addresses.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'No host is available for the requested instance.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"MigrationId\\": 3298015,\\n \\"RequestId\\": \\"355DA57C-8CC4-40AB-B3F8-B684BA32EB9E\\",\\n \\"TaskId\\": 208676661\\n}","errorExample":""},{"type":"xml","example":"\\n3298015\\n355DA57C-8CC4-40AB-B3F8-B684BA32EB9E\\n208676661\\n","errorExample":""}]', 'title' => 'RebuildDBInstance', 'description' => 'Dedicated clusters allow you to manage a number of instances at a time. You can create multiple dedicated clusters in a single region. Each dedicated cluster consists of multiple hosts. You can create multiple instances on each host. For more information, see [What is ApsaraDB MyBase?](~~141455~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'MigrateConnectionToOtherZone' => [ 'summary' => 'Migrates an instance to a different zone.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-bp1oypo6ky19y****', ], ], [ 'name' => 'ConnectionString', 'in' => 'query', 'schema' => [ 'description' => 'The endpoint of the instance. The endpoint is specified when you create the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-bp1oypo6ky19y****', ], ], [ 'name' => 'ZoneId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the zone.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou-i', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Code' => [ 'description' => 'The error code.'."\n", 'type' => 'string', 'example' => 'InvalidParam', ], 'Message' => [ 'description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'Invalid Parameter.', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '65BDA532-28AF-4122-AA39-B382721EEE64', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'ZoneIdNotSupported', 'errorMessage' => 'The zone ID is not supported.', ], [ 'errorCode' => 'ConnectionNotFound', 'errorMessage' => 'The connection is not found.', ], [ 'errorCode' => 'DBInstanceStatusNotActive', 'errorMessage' => 'The status of the current instance is not active.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'The specified parameter is invalid.', ], [ 'errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance does not exist or is not supported.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"InvalidParam\\",\\n \\"Message\\": \\"Invalid Parameter.\\",\\n \\"RequestId\\": \\"65BDA532-28AF-4122-AA39-B382721EEE64\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n Invalid Parameter.\\r\\n 65BDA532-28AF-4122-AA39-B382721EEE64\\r\\n InvalidParam\\r\\n","errorExample":""}]', 'title' => 'MigrateConnectionToOtherZone', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> Before you call this operation, read the following documentation and make sure that you fully understand the prerequisites and impacts of this operation.'."\n" ."\n" .'* [Migrate an ApsaraDB RDS for MySQL instance across zones in the same region](~~96746~~)'."\n" .'* [Migrate an ApsaraDB RDS for PostgreSQL instance across zones in the same region](~~96746~~)'."\n" .'* [Migrate an ApsaraDB RDS for SQL Server instance across zones in the same region](~~95658~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ModifyDBInstanceDelayedReplicationTime' => [ 'summary' => 'Configures the replication latency for a read-only ApsaraDB RDS for MySQL instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the [DescribeDBInstances](~~26232~~) operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-uf6wjk5*****', ], ], [ 'name' => 'ReadSQLReplicationTime', 'in' => 'query', 'schema' => [ 'description' => 'The replication latency of the read-only instance. Unit: seconds.'."\n", 'type' => 'string', 'required' => true, 'example' => '100', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'DBInstanceId' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5*****', ], 'ReadSQLReplicationTime' => [ 'description' => 'The replication latency of the read-only instance. Unit: seconds.'."\n", 'type' => 'string', 'example' => '100', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'EFB6083A-7699-489B-8278-C0CB4793A96E', ], 'TaskId' => [ 'description' => 'The task ID.'."\n", 'type' => 'string', 'example' => '1715482.0', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OperationDenied.DBInstanceType', 'errorMessage' => 'The operation is not permitted due to type of instance.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'EngineNotSupported', 'errorMessage' => 'Engine specified cannot be supported the operation.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBInstanceId\\": \\"rr-uf6wjk5****\\",\\n \\"ReadSQLReplicationTime\\": \\"100\\",\\n \\"RequestId\\": \\"EFB6083A-7699-489B-8278-C0CB4793A96E\\",\\n \\"TaskId\\": \\"1715482.0\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 1715482.0\\n 49A3225B-5DFC-1885-8EFC-A4BCCBCD1EAD\\n","errorExample":""}]', 'title' => 'ModifyDBInstanceDelayedReplicationTime', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.'."\n" ."\n" .'* [Configure a data replication latency for a read-only ApsaraDB RDS for MySQL instance](~~96056~~)'."\n", ], 'CheckServiceLinkedRole' => [ 'summary' => 'Checks whether a service-linked role (SLR) is created.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID.'."\n" ."\n" .'> You can specify any region for this parameter, which does not affect your query results. You can call the [DescribeRegions](~~26243~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'ServiceLinkedRole', 'in' => 'query', 'schema' => [ 'description' => 'The SLR name.'."\n" ."\n" .'> For more information about the SLRs supported by ApsaraDB RDS, see [Service-linked roles](~~342840~~).'."\n", 'type' => 'string', 'required' => true, 'example' => 'AliyunServiceRoleForRdsPgsqlOnEcs', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-bp67acfmxazb4p****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'HasServiceLinkedRole' => [ 'description' => 'Indicates whether an SLR is created.'."\n", 'type' => 'string', 'example' => 'true', ], 'RequireServiceLinkedRole' => [ 'description' => 'Indicates whether the service-linked role is required. Default value: true.', 'type' => 'string', 'example' => 'true', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'AB44DC0A-7E77-442A-97A9-C6418694CB22', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidParameterGroupId.Malformed', 'errorMessage' => 'Specified parameterGroupId is not valid.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"HasServiceLinkedRole\\": \\"true\\",\\n \\"RequireServiceLinkedRole\\": \\"true\\",\\n \\"RequestId\\": \\"AB44DC0A-7E77-442A-97A9-C6418694CB22\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n AB44DC0A-7E77-442A-97A9-C6418694CB22\\n","errorExample":""}]', 'title' => 'CheckServiceLinkedRole', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* PostgreSQL'."\n", ], 'DescribeDBMiniEngineVersions' => [ 'summary' => 'Queries minor engine versions that are available for an ApsaraDB RDS for MySQL instance or an ApsaraDB RDS for PostgreSQL instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'Engine', 'in' => 'query', 'schema' => [ 'description' => 'The database engine of the instance. Valid values: **MySQL** and **PostgreSQL**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'MySQL', ], ], [ 'name' => 'EngineVersion', 'in' => 'query', 'schema' => [ 'description' => 'The database engine version of the instance. Valid values:'."\n" ."\n" .'* Valid values when you set the Engine parameter to MySQL: **8.0**, **5.7**, **5.6**, and **5.5**'."\n" .'* Valid values when you set the Engine parameter to PostgreSQL: **15.0**, **14.0**, **13.0**, **12.0**, **11.0**, and **10.0**'."\n", 'type' => 'string', 'required' => false, 'example' => '5.7', ], ], [ 'name' => 'NodeType', 'in' => 'query', 'schema' => [ 'description' => 'The instance edition. Valid values:'."\n" ."\n" .'* **Basic**: RDS Basic Edition'."\n" .'* **HighAvailability**: RDS High-availability Edition'."\n" .'* **Finance**: RDS Enterprise Edition'."\n", 'type' => 'string', 'required' => false, 'example' => 'HighAvailability', ], ], [ 'name' => 'StorageType', 'in' => 'query', 'schema' => [ 'description' => 'The storage type of the instance. Valid values:'."\n" ."\n" .'* **local_ssd**: local SSD'."\n" .'* **cloud_ssd**: standard SSD'."\n" .'* **cloud_essd**: enhanced SSD (ESSD) of performance level 1 (PL1)'."\n" .'* **cloud_essd2**: ESSD of PL2'."\n" .'* **cloud_essd3**: ESSD of PL3'."\n", 'type' => 'string', 'required' => false, 'example' => 'local_ssd', ], ], [ 'name' => 'DedicatedHostGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The dedicated cluster ID. You can call the DescribeDedicatedHostGroups operation to query the dedicated cluster ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'dhg-4n*****', ], ], [ 'name' => 'MinorVersionTag', 'in' => 'query', 'schema' => [ 'description' => 'The minor engine version of the instance. You can specify this parameter to query the minor engine version of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rds_20220731', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rm-uf6wjk5*******', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'DBInstanceId' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5*****', ], 'MaxRecordsPerPage' => [ 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'MinorVersionItems' => [ 'description' => 'The details of the minor engine version.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'CommunityMinorVersion' => [ 'description' => 'The PostgreSQL version to which the minor engine version corresponds. For more information, see [Release notes for AliPG](~~126002~~).'."\n" ."\n" .'> This parameter is available only for instances that run **PostgreSQL**.'."\n", 'type' => 'string', 'example' => '13.6', ], 'Engine' => [ 'description' => 'The database engine that corresponds to the minor engine version.'."\n", 'type' => 'string', 'example' => 'MySQL', ], 'EngineVersion' => [ 'description' => 'The database engine version that corresponds to the minor engine version.'."\n", 'type' => 'string', 'example' => '5.7', ], 'ExpireDate' => [ 'description' => 'The expiration time of the minor engine version.'."\n", 'type' => 'string', 'example' => '20231213', ], 'ExpireStatus' => [ 'title' => '内核版本过期状态：vaild-有效；expired-过期', 'description' => 'The expiration status of the minor engine version. Valid values:'."\n" ."\n" .'* **vaild**'."\n" .'* **expired**'."\n" ."\n" .'> If the minor engine version is in the Offline state, the minor engine version is discontinued. In this case, ignore the expiration status. If the minor engine version is in the Online state and the expiration state is expired, the minor engine version expires. If the expiration state is vaild, the minor engine version is still in its lifecycle.'."\n", 'type' => 'string', 'enumValueTitles' => [], 'example' => 'vaild', 'enum' => [ 'vaild', 'expired', ], ], 'IsHotfixVersion' => [ 'description' => 'An internal parameter. You do not need to specify this parameter.'."\n", 'type' => 'boolean', 'example' => 'True', ], 'MinorVersion' => [ 'description' => 'The minor engine version.'."\n", 'type' => 'string', 'example' => 'rds_20220731', ], 'NodeType' => [ 'description' => 'The RDS edition of the instance that runs the minor engine version. Valid values:'."\n" ."\n" .'* **Basic**: RDS Basic Edition'."\n" .'* **HighAvailability**: RDS High-availability Edition'."\n" .'* **Finance**: RDS Enterprise Edition'."\n", 'type' => 'string', 'example' => 'HighAvailability', ], 'ReleaseNote' => [ 'description' => 'The URL of the release notes for the minor engine version.'."\n", 'type' => 'string', 'example' => 'https://example.com', ], 'ReleaseType' => [ 'description' => 'The release type. Valid values:'."\n" ."\n" .'* **LTS**: a long-term version'."\n" .'* **BETA**: a preview version'."\n", 'type' => 'string', 'example' => 'BETA', ], 'StatusDesc' => [ 'title' => '内核版本下线状态：offline-下线', 'description' => 'The status of the minor engine version. Valid values:'."\n" ."\n" .'* **Offline**: discontinued'."\n" .'* **Online**: available'."\n" ."\n" .'> If the minor engine version is in the Offline state, the minor engine version is discontinued. In this case, ignore the expiration status. If the minor engine version is in the Online state and the expiration state is expired, the minor engine version expires. If the expiration state is vaild, the minor engine version is still in its lifecycle.'."\n", 'type' => 'string', 'example' => 'Online', ], 'Tag' => [ 'description' => 'The tag that corresponds to the minor engine version. Valid values:'."\n" ."\n" .'* **pgsql_docker_image**: tag of common instances'."\n" .'* **pgsql_babelfish_image**: tag of instances for which Babelfish is enabled'."\n" ."\n" .'> This parameter is available only for instances that run **PostgreSQL**.'."\n", 'type' => 'string', 'example' => 'pgsql_babelfish_image', ], ], ], ], 'PageNumbers' => [ 'description' => 'The page number returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'EFB6083A-7699-489B-8278-C0CB4793A96E', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'MinorVersionAttr.NotFound', 'errorMessage' => 'Cannot find minor version attribute by given custins.', ], [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The specified DB instance name does not exist.', ], [ 'errorCode' => 'EngineNotSupported', 'errorMessage' => 'Engine specified cannot be supported the operation.', ], [ 'errorCode' => 'MissingMinorVersionTag', 'errorMessage' => 'You must specify MinorVersionTag.', ], [ 'errorCode' => 'MissingParameter.Engine', 'errorMessage' => 'You must specify Engine.', ], [ 'errorCode' => 'MissingParameter.EngineVersion', 'errorMessage' => 'You must specify EngineVersion.', ], [ 'errorCode' => 'InvalidInstanceNodeType.NotFound', 'errorMessage' => 'The specified NodeType is not found.', ], [ 'errorCode' => 'MinorVersionTag.NotFound', 'errorMessage' => 'Minor version tags cannot be parsed by the instance.', ], [ 'errorCode' => 'InvalidVersion', 'errorMessage' => 'current version not support operation.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidInstanceStorageType.NotFound', 'errorMessage' => 'The specified DBInstanceStorageType is not found.', ], [ 'errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance does not exist or is not supported.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBInstanceId\\": \\"rm-uf6wjk5****\\",\\n \\"MaxRecordsPerPage\\": 10,\\n \\"MinorVersionItems\\": [\\n {\\n \\"CommunityMinorVersion\\": \\"5.7.38\\",\\n \\"Engine\\": \\"MySQL\\",\\n \\"EngineVersion\\": \\"5.7\\",\\n \\"ExpireDate\\": \\"20231213\\",\\n \\"ExpireStatus\\": \\"vaild\\",\\n \\"IsHotfixVersion\\": true,\\n \\"MinorVersion\\": \\"rds_20220731\\",\\n \\"NodeType\\": \\"HighAvailability\\",\\n \\"ReleaseNote\\": \\"https://example.com\\",\\n \\"ReleaseType\\": \\"BETA\\",\\n \\"StatusDesc\\": \\"Online\\",\\n \\"Tag\\": \\"pgsql_babelfish_image\\"\\n }\\n ],\\n \\"PageNumbers\\": 1,\\n \\"RequestId\\": \\"EFB6083A-7699-489B-8278-C0CB4793A96E\\",\\n \\"TotalCount\\": 2\\n}","errorExample":""},{"type":"xml","example":"\\n rm-uf6wjk5*****\\n EFB6083A-7699-489B-8278-C0CB4793A96E\\n 2\\n 1\\n 10\\n \\n https://example.com\\n HighAvailability\\n true\\n MySQL\\n BETA\\n Online\\n 5.7\\n rds_20220731\\n \\n","errorExample":""}]', 'title' => 'DescribeDBMiniEngineVersions', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" ."\n" .'### [](#)Usage notes'."\n" ."\n" .'Before you purchase or upgrade an instance that runs MySQL or PostgreSQL, you can call the DescribeDBMiniEngineVersions operation to query the minor engine versions that are available for the instance.'."\n", ], 'DescribeRegionInfos' => [ 'summary' => 'Queries the regions.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the generated token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCz*****', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Regions' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'RDSRegion' => [ 'description' => 'A list of regions.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'RegionId' => [ 'description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], ], ], ], ], ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '5414A4E5-4C36-4461-95FC-************', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'InvaildEngineInRegion.NotAvailable', 'errorMessage' => 'The Engine in the Region is not available.', ], [ 'errorCode' => 'OperationDenied', 'errorMessage' => 'The resource is out of usage.', ], [ 'errorCode' => 'RegionUnauthorized', 'errorMessage' => 'There is no authority to create instance in the specified region.', ], [ 'errorCode' => 'QuotaExceeded.CreateInstance', 'errorMessage' => 'The quota of create instance exceeds.', ], [ 'errorCode' => 'Forbidden.Authentication', 'errorMessage' => 'The operation is forbidden by Aliyun Realname Authentication System.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Regions\\": {\\n \\"RDSRegion\\": [\\n {\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"5414A4E5-4C36-4461-95FC-****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 5414A4E5-4C36-4461-95FC-************\\n \\n cn-hangzhou\\n \\n","errorExample":""}]', 'title' => 'DescribeRegionInfos', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" .'* MariaDB'."\n", ], 'DescribeDBInstanceNetInfoForChannel' => [ 'summary' => 'Queries all endpoints of an instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => '0c593ea1-3bea-11e9-b96b-88**********', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the instance. You can call the [DescribeDBInstances](~~26232~~) operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-bp1k8s41l2o52****', ], ], [ 'name' => 'Flag', 'in' => 'query', 'schema' => [ 'description' => 'An internal parameter. You do not need to specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'None'."\n", 'default' => '0', ], ], [ 'name' => 'DBInstanceNetRWSplitType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the endpoint to query. Valid values:'."\n" ."\n" .'* **0**: a regular endpoint. This is the default value.'."\n" .'* **1**: a read/write splitting endpoint that is assigned after the shared proxy feature is enabled.'."\n", 'type' => 'string', 'required' => false, 'example' => '0', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'DBInstanceNetInfos' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'DBInstanceNetInfo' => [ 'description' => 'The information about the instance connection.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Availability' => [ 'description' => 'The availability of the instance. Valid values:'."\n" ."\n" .'* **Unavailable**'."\n" .'* **Available**'."\n", 'type' => 'string', 'example' => 'Unavailable', ], 'ConnectionString' => [ 'description' => 'The endpoint of the instance.'."\n", 'type' => 'string', 'example' => 'rm-uf6w*****.mysql.rds.aliyuncs.com', ], 'ConnectionStringType' => [ 'description' => 'The type of the endpoint. Valid values:'."\n" ."\n" .'* **Normal**: a regular endpoint'."\n" .'* **ReadWriteSplitting**: a read/write splitting endpoint that is assigned after the shared proxy feature is enabled.'."\n", 'type' => 'string', 'example' => 'Normal', ], 'DBInstanceWeights' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'DBInstanceWeight' => [ 'description' => 'The information about read weights to implement read/write splitting after the shared proxy feature is enabled.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Availability' => [ 'description' => 'The availability of the instance. Valid values:'."\n" ."\n" .'* **Unavailable**'."\n" .'* **Available**'."\n", 'type' => 'string', 'example' => 'Unavailable', ], 'DBInstanceId' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5*****', ], 'DBInstanceType' => [ 'description' => 'The instance type. Valid values:'."\n" ."\n" .'* **Master**: primary instance'."\n" .'* **Readonly**: read-only instance'."\n", 'type' => 'string', 'example' => 'Master', ], 'Weight' => [ 'description' => 'The weight of the instance.'."\n", 'type' => 'string', 'example' => '100', ], ], ], ], ], ], 'DistributionType' => [ 'description' => 'The policy that is used to assign read weights. This parameter is returned only for a read/write splitting endpoint that is assigned after the shared proxy feature is enabled. Valid values:'."\n" ."\n" .'* **Standard**: The system automatically allocates read weights to the instance and its read-only instances based on the specifications of the instances.'."\n" .'* **Custom**: You must manually allocate read weights to the instance and its read-only instances.'."\n", 'type' => 'string', 'example' => 'Standard', ], 'IPAddress' => [ 'description' => 'The IP address of the instance.'."\n", 'type' => 'string', 'example' => '172.16.XX.XX', ], 'IPType' => [ 'description' => 'The network type of the IP address. Valid values:'."\n" ."\n" .'* **Public**: the Internet'."\n" .'* **Inner**: the classic network'."\n" .'* **Private**: a virtual private cloud (VPC)'."\n", 'type' => 'string', 'example' => 'Inner', ], 'MaxDelayTime' => [ 'description' => 'The latency threshold that is allowed for read/write splitting of the shared proxy feature. Unit: seconds.'."\n" ."\n" .'> This parameter is returned only when **ConnectionStringType** is set to **ReadWriteSplitting**.'."\n", 'type' => 'string', 'example' => '12', ], 'Port' => [ 'description' => 'The port number of the instance.'."\n", 'type' => 'string', 'example' => '6379', ], 'SecurityIPGroups' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'securityIPGroup' => [ 'description' => 'The details of the IP address whitelist.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'SecurityIPGroupName' => [ 'description' => 'The name of the IP address whitelist.'."\n", 'type' => 'string', 'example' => 'Default', ], 'SecurityIPs' => [ 'description' => 'The IP addresses that is contained in the IP address whitelist.'."\n", 'type' => 'string', 'example' => '127.0.XX.XX', ], ], ], ], ], ], 'Upgradeable' => [ 'description' => 'An internal parameter. You do not need to specify this parameter.'."\n", 'type' => 'string', 'example' => 'Disabled', ], 'VPCId' => [ 'description' => 'The VPC ID of the instance.'."\n", 'type' => 'string', 'example' => 'vpc-bp1nme44gek34slfc****', ], 'VSwitchId' => [ 'description' => 'The vSwitch ID of the instance.'."\n", 'type' => 'string', 'example' => 'vsw-bp1e7clcw529l773d****', ], 'expiredTime' => [ 'description' => 'The expiration time of the endpoint of the classic network type. Unit: seconds.'."\n", 'type' => 'string', 'example' => '5183779', ], ], ], ], ], ], 'InstanceNetworkType' => [ 'description' => 'The network type of the instance. Valid values:'."\n" ."\n" .'* **VPC**: a virtual private cloud (VPC)'."\n" .'* **Classic**: classic network'."\n", 'type' => 'string', 'example' => 'VPC', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '61DF1F28-F409-50C0-B90A-CCE82D44****', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Forbidden.RAM', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'AccountLeastAssociateOneDB', 'errorMessage' => 'Retain at least one account in a DB.', ], ], 403 => [ [ 'errorCode' => 'IncorrectDBInstanceCharacterType', 'errorMessage' => 'Current DB Instance character_type does not support this operation.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', ], [ 'errorCode' => 'Readins.NotFound', 'errorMessage' => 'The current instance does not contain any read only instance. The operation is not supported.', ], [ 'errorCode' => 'InvalidRwSplitNetType.NotFound', 'errorMessage' => 'The RwSplitNetType is not found.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"DBInstanceNetInfos\\": {\\n \\"DBInstanceNetInfo\\": [\\n {\\n \\"Availability\\": \\"Unavailable\\",\\n \\"ConnectionString\\": \\"rm-uf6w****.mysql.rds.aliyuncs.com\\",\\n \\"ConnectionStringType\\": \\"Normal\\",\\n \\"DBInstanceWeights\\": {\\n \\"DBInstanceWeight\\": [\\n {\\n \\"Availability\\": \\"Unavailable\\",\\n \\"DBInstanceId\\": \\"rm-uf6wjk5****\\",\\n \\"DBInstanceType\\": \\"Master\\",\\n \\"Weight\\": \\"100\\"\\n }\\n ]\\n },\\n \\"DistributionType\\": \\"Standard\\",\\n \\"IPAddress\\": \\"172.16.XX.XX\\",\\n \\"IPType\\": \\"Inner\\",\\n \\"MaxDelayTime\\": \\"12\\",\\n \\"Port\\": \\"6379\\",\\n \\"SecurityIPGroups\\": {\\n \\"securityIPGroup\\": [\\n {\\n \\"SecurityIPGroupName\\": \\"Default\\",\\n \\"SecurityIPs\\": \\"127.0.XX.XX\\"\\n }\\n ]\\n },\\n \\"Upgradeable\\": \\"Disabled\\",\\n \\"VPCId\\": \\"vpc-bp1nme44gek34slfc****\\",\\n \\"VSwitchId\\": \\"vsw-bp1e7clcw529l773d****\\",\\n \\"expiredTime\\": \\"5183779\\"\\n }\\n ]\\n },\\n \\"InstanceNetworkType\\": \\"VPC\\",\\n \\"RequestId\\": \\"61DF1F28-F409-50C0-B90A-CCE82D44****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 61DF1F28-F409-50C0-B90A-CCE82D44FE4A\\n \\n \\n Private\\n Available\\n vpc-bp1tg4looivio6z54ukk0\\n 1433\\n vsw-bp14kk6kepwwff4j8rcny\\n Disabled\\n rm-bp1k8s41l2o529f91.sqlserver.rds.aliyuncs.com\\n 172.21.10.62\\n \\n \\n \\n \\n Normal\\n \\n \\n VPC\\n","errorExample":""}]', 'title' => 'DescribeDBInstanceNetInfoForChannel', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" .'* MariaDB'."\n", ], 'DescribeHostWebShell' => [ 'summary' => 'Queries the webshell URL that is used to connect to the host of an ApsaraDB RDS for SQL Server instance.', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-uf6wjk5xxxxxxx', ], ], [ 'name' => 'RegionID', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the instance. You can call the DescribeDBInstanceAttribute operation to query the region ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'HostName', 'in' => 'query', 'schema' => [ 'description' => 'The instance hostname. You can call the DescribeDBInstanceIpHostname operation to query the hostname.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testHost1', ], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => [ 'description' => 'The username of the account that is used to log on to the host of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testOsAccount1', ], ], [ 'name' => 'AccountPassword', 'in' => 'query', 'schema' => [ 'description' => 'The password of the host account.'."\n", 'type' => 'string', 'required' => true, 'example' => '***', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'LoginUrl' => [ 'description' => 'The webshell URL.'."\n", 'type' => 'string', 'example' => '***', ], 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '842B73C8-5776-4BD9-9872-69C8C46DD7D3', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'WebShellLoginFailed', 'errorMessage' => '%s,%s.', ], [ 'errorCode' => 'InvalidUserId.NotSupport', 'errorMessage' => 'The user ID has no permission.', ], [ 'errorCode' => 'InvalidHostStatus.Format', 'errorMessage' => 'Specified host status is not valid.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'ClusterTypeNotSupported', 'errorMessage' => 'The current Instance ClusterType does not support this operation.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], [ 'errorCode' => 'InvalidAccountName.NotFound', 'errorMessage' => 'Specified account name does not exist.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"LoginUrl\\": \\"****\\",\\n \\"RequestId\\": \\"842B73C8-5776-4BD9-9872-69C8C46DD7D3\\"\\n}","type":"json"}]', 'title' => 'DescribeHostWebShell', 'description' => '### [](#)Supported database engine'."\n" ."\n" .'* SQL Server'."\n" ."\n" .'### [](#)Prerequisite'."\n" ."\n" .'* The instance meets the following requirements:'."\n" ."\n" .' * The instance resides in a region other than the China (Zhangjiakou) region.'."\n" .' * The instance runs RDS Basic Edition, RDS Cluster Edition, or RDS High-availability Edition. If your instance runs RDS High-availability Edition, make sure that the instance runs SQL Server 2012 or later.'."\n" .' * The instance belongs to the general-purpose or dedicated instance family. The shared instance family is not supported.'."\n" .' * The instance resides in a virtual private cloud (VPC). For more information about how to change the network type of an RDS instance, see [Change the network type](~~95707~~).'."\n" .' * If the instance runs RDS High-availability Edition or RDS Cluster Edition, the instance is created on or after January 1, 2021. If the instance runs RDS Basic Edition, the instance is created on or after September 02, 2022. You can view the **Creation Time** parameter of an instance in the **Status** section of the **Basic Information** page in the ApsaraDB RDS console.'."\n" ."\n" .'* Your **Alibaba Cloud account** is used for logons.'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.'."\n" ."\n" .'[Create a host account and use the host account for logons](~~354862~~)'."\n", ], 'DescribeClassDetails' => [ 'summary' => 'Queries the details about the instance types of an instance by using the code of the instance types.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the generated token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCz*****', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'CommodityCode', 'in' => 'query', 'schema' => [ 'description' => 'The commodity code of the instance. Valid values:'."\n" ."\n" .'* **bards_intl**: The instance is a pay-as-you-go primary instance.'."\n" .'* **rds_intl**: The instance is a subscription primary instance.'."\n" .'* **rords_intl**: The instance is a pay-as-you-go read-only instance.'."\n" .'* **rds_rordspre_public_intl**: The instance is a subscription read-only instance.', 'type' => 'string', 'required' => true, 'example' => 'rds', ], ], [ 'name' => 'ClassCode', 'in' => 'query', 'schema' => [ 'description' => 'The code of the instance type.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rds.mysql.s3.large', ], ], [ 'name' => 'EngineVersion', 'in' => 'query', 'schema' => [ 'description' => 'The database engine version of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => '5.6', ], ], [ 'name' => 'Engine', 'in' => 'query', 'schema' => [ 'description' => 'The type of the database engine.'."\n", 'type' => 'string', 'required' => true, 'example' => 'MySQL', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The resource group ID. You can call the DescribeDBInstanceAttribute operation to query the resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy*****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Category' => [ 'description' => 'The RDS edition of the instance. Valid values:'."\n" ."\n" .'* **Basic**: RDS Basic Edition'."\n" .'* **HighAvailability**: RDS High-availability Edition'."\n" .'* **AlwaysOn**: RDS Cluster Edition'."\n" .'* **Finance**: RDS Enterprise Edition'."\n", 'type' => 'string', 'example' => 'Basic', ], 'ClassCode' => [ 'description' => 'The code of the instance type.'."\n", 'type' => 'string', 'example' => 'mysql.n2.medium.1', ], 'ClassGroup' => [ 'description' => 'The instance family of the instance.'."\n", 'type' => 'string', 'example' => 'x', ], 'Cpu' => [ 'description' => 'The number of CPU cores that are supported by the instance type. Unit: cores.'."\n", 'type' => 'string', 'example' => '4', ], 'DBInstanceStorageType' => [ 'description' => 'The storage type of the instance. Valid values:'."\n" ."\n" .'* **local_ssd**: local SSDs'."\n" .'* **cloud_ssd**: standard SSDs'."\n" .'* **cloud_essd**: enhanced SSDs (ESSDs) of performance level 1 (PL1)'."\n" .'* **cloud_essd2**: ESSDs of PL2'."\n" .'* **cloud_essd3**: ESSD of PL3'."\n", 'type' => 'string', 'example' => 'local_ssd', ], 'InstructionSetArch' => [ 'description' => 'The architecture of the instance.'."\n", 'type' => 'string', 'example' => 'x86', ], 'MaxConnections' => [ 'description' => 'The maximum number of connections.'."\n", 'type' => 'string', 'example' => '4000', ], 'MaxIOMBPS' => [ 'description' => 'The maximum I/O bandwidth that is supported by the instance type. Unit: Mbit/s.'."\n", 'type' => 'string', 'example' => '1024', ], 'MaxIOPS' => [ 'description' => 'The maximum input/output operations per second (IOPS) that is supported by the instance type. Unit: operations per second.'."\n", 'type' => 'string', 'example' => 'N/A', ], 'MemoryClass' => [ 'description' => 'The memory size. Unit: GB.'."\n", 'type' => 'string', 'example' => '2GB', ], 'ReferencePrice' => [ 'description' => 'The price.'."\n" ."\n" .'Unit: cents (US dollars).'."\n" ."\n" .'> * If you set the CommodityCode parameter to a value that indicates the pay-as-you-go billing method, the ReferencePrice parameter specifies the hourly fee that you must pay.'."\n" .'> * If you set the CommodityCode parameter to a value that indicates the subscription billing method, the ReferencePrice parameter specifies the monthly fee that you must pay.', 'type' => 'string', 'example' => '13400', ], 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'E9DD55F4-1A5F-48CA-BA57-DFB3CA8C4C34', ], ], ], ], [], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidClassCode.NotFound', 'errorMessage' => 'Invalid ClassCode NotFound.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Category\\": \\"Basic\\",\\n \\"ClassCode\\": \\"mysql.n2.medium.1\\",\\n \\"ClassGroup\\": \\"x\\",\\n \\"Cpu\\": \\"4\\",\\n \\"DBInstanceStorageType\\": \\"local_ssd\\",\\n \\"InstructionSetArch\\": \\"x86\\",\\n \\"MaxConnections\\": \\"4000\\",\\n \\"MaxIOMBPS\\": \\"1024\\",\\n \\"MaxIOPS\\": \\"N/A\\",\\n \\"MemoryClass\\": \\"2GB\\",\\n \\"ReferencePrice\\": \\"13400\\",\\n \\"RequestId\\": \\"E9DD55F4-1A5F-48CA-BA57-DFB3CA8C4C34\\"\\n}","type":"json"}]', 'title' => 'DescribeClassDetails', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" .'* MariaDB'."\n", ], 'DescribeKmsAssociateResources' => [ 'summary' => 'Checks whether the specified resource of Key Management Service (KMS) is associated with an ApsaraDB RDS instance.', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests.'."\n" ."\n" .'The token can contain only ASCII characters and cannot exceed 64 characters in length.', 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCz****', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-bp67acfmxazb4p****', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the DescribeRegions operation to query the most recent region list.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'KmsResourceRegionId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the region to which the KMS resource belongs.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'KmsResourceUser', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the Alibaba Cloud account to which the KMS resource belongs.'."\n", 'type' => 'string', 'required' => true, 'example' => '164882191396****', ], ], [ 'name' => 'KmsResourceType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the KMS resource. Only key is supported.', 'type' => 'string', 'required' => true, 'example' => 'key', ], ], [ 'name' => 'KmsResourceId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the KMS resource. Only key IDs are supported.'."\n", 'type' => 'string', 'required' => true, 'example' => '494c98ce-f2b5-48ab-96ab-36c986b6****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'AssociateDBInstances' => [ 'description' => 'The information about the associated ApsaraDB RDS instances.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'DBInstanceName' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'pgm-bp16p6f68130****', ], 'Engine' => [ 'description' => 'The database engine. Valid values:'."\n" ."\n" .'* **MySQL**'."\n" .'* **SQLServer**'."\n" .'* **PostgreSQL**'."\n", 'type' => 'string', 'example' => 'PostgreSQL', ], 'KeyUsedBy' => [ 'description' => 'The purpose of the key. Valid values:'."\n" ."\n" .'* **DiskEncryption**: cloud disk encryption'."\n" .'* **TDE**: transparent data encryption'."\n", 'type' => 'string', 'example' => 'DiskEncryption', ], 'Status' => [ 'description' => 'The state of the instance. Valid values:'."\n" ."\n" .'* **CREATING**: The instance is being created.'."\n" .'* **ACTIVATION**: The instance is running.'."\n" .'* **DELETING**: The instance is being deleted.'."\n" .'* **RESTARTING**: The instance is being restarted.'."\n" .'* **INS_MAINTAINING**: The configuration of the instance is being changed.'."\n" .'* **INS_MAINTAINING**: The instance is being maintained.'."\n" .'* **BACKUP_RECOVERING**: The instance is being restored.'."\n" .'* **NET_MODIFYING**: The network type of the instance is being changed.'."\n", 'type' => 'string', 'example' => 'ACTIVATION', ], ], ], ], 'AssociateStatus' => [ 'description' => 'Indicates whether an associated RDS instance exists.'."\n" ."\n" .'- **true**: Yes'."\n" .'- **false**: No', 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidParameter', 'errorMessage' => 'Invalid parameter.', ], [ 'errorCode' => 'InvalidUserId.NotSupport', 'errorMessage' => 'The userid have no permission.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AssociateDBInstances\\": [\\n {\\n \\"DBInstanceName\\": \\"pgm-bp16p6f68130****\\",\\n \\"Engine\\": \\"PostgreSQL\\",\\n \\"KeyUsedBy\\": \\"DiskEncryption\\",\\n \\"Status\\": \\"ACTIVATION\\"\\n }\\n ],\\n \\"AssociateStatus\\": true,\\n \\"RequestId\\": \\"38F6B598-A6D7-508A-8401-12BB9936****\\"\\n}","type":"json"}]', 'title' => 'DescribeKmsAssociateResources', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n", ], 'DescribeRCSnapshots' => [ 'summary' => 'Queries the details of snapshots. The details include the status of the snapshots, the amount of remaining time required to create the snapshots, and the retention period of the automatic snapshots in days.', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'DiskId', 'in' => 'query', 'schema' => [ 'description' => 'The cloud disk ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rcd-wz9c8isqly8637zw****', ], ], [ 'name' => 'SnapshotIds', 'in' => 'query', 'schema' => [ 'description' => 'The snapshot IDs.'."\n" ."\n" .'You can specify a maximum of 100 IDs. Separate multiple IDs with commas (,).'."\n", 'type' => 'string', 'required' => false, 'example' => '["rcds-bp67acfmxazb4p****", "rcds-bp67acfmxazb5p****", … "rcds-bp67acfmxazb6p****"]', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page. Valid values: **30** to **100**. Default value: **30**.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '50', 'minimum' => '1', 'example' => '30', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Key' => [ 'type' => 'string', ], 'Value' => [ 'type' => 'string', ], ], ], 'maxItems' => 21, ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'type' => 'string', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Snapshots' => [ 'description' => 'The details of snapshots.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details of the snapshot.'."\n", 'type' => 'object', 'properties' => [ 'Available' => [ 'description' => 'Indicates whether the snapshot can be shared and used to create or roll back a cloud disk. Valid values:'."\n" ."\n" .'* true'."\n" .'* false'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Category' => [ 'description' => 'The snapshot type. Valid values:'."\n" ."\n" .'* Standard: standard snapshot'."\n" .'* Flash: local snapshot This value will be deprecated. The local snapshot feature is replaced with the instant access feature.'."\n" .'* archive: archived snapshot'."\n", 'type' => 'string', 'example' => 'Standard', ], 'CreationTime' => [ 'description' => 'The creation time. The time follows the [ISO 8601](~~25696~~) standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2024-10-18T09:37:14Z', ], 'Description' => [ 'description' => 'The snapshot description.'."\n", 'type' => 'string', 'example' => 'zd_test', ], 'Encrypted' => [ 'description' => 'Indicates whether the snapshot was encrypted. Valid values:'."\n" ."\n" .'* true'."\n" .'* false'."\n", 'type' => 'boolean', 'example' => 'true', ], 'InstantAccess' => [ 'description' => 'This parameter is deprecated.'."\n", 'type' => 'boolean', 'example' => 'none', ], 'Progress' => [ 'description' => 'The progress of the snapshot creation task in percentage.'."\n", 'type' => 'string', 'example' => '100', ], 'RegionId' => [ 'description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], 'SnapshotId' => [ 'description' => 'The snapshot ID.'."\n", 'type' => 'string', 'example' => 'rcds-hc1zg51xobdg4****', ], 'SnapshotName' => [ 'description' => 'The snapshot name.'."\n", 'type' => 'string', 'example' => 's-2ze8klip00xcogcwer76', ], 'SnapshotType' => [ 'description' => 'The snapshot type. Valid values:'."\n" ."\n" .'* auto or timer: automatically created snapshot'."\n" .'* user: manually created snapshot'."\n" .'* all: all snapshot types'."\n", 'type' => 'string', 'example' => 'auto', ], 'SourceDiskId' => [ 'description' => 'The ID of the original disk. This parameter is retained even after the original disk for which the snapshot was created is released.'."\n", 'type' => 'string', 'example' => 'rcd-bp67acfmxazb4ph****', ], 'SourceDiskSize' => [ 'description' => 'The storage capacity of the original disk. Unit: GiB.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '60', ], 'SourceDiskType' => [ 'description' => 'The type of the original disk. Valid values:'."\n" ."\n" .'* SYSTEM: system disk'."\n" .'* DATA: data disk'."\n", 'type' => 'string', 'example' => 'data', ], 'SourceStorageType' => [ 'description' => 'The type of the source disk.'."\n" ."\n" .'> This parameter will be removed in the future. To ensure future compatibility, we recommend that you use other parameters.'."\n", 'type' => 'string', 'example' => 'disk', ], 'Status' => [ 'description' => 'The snapshot status. Valid values:'."\n" ."\n" .'* progressing: The snapshot is being created.'."\n" .'* accomplished: The snapshot is created.'."\n" .'* failed: The snapshot fails to be created.'."\n", 'type' => 'string', 'example' => 'progressing', ], 'Usage' => [ 'description' => 'Indicates whether the snapshot is used to create custom images or disks. Valid values:'."\n" ."\n" .'* image: The snapshot is used to create custom images.'."\n" .'* disk: The snapshot is used to create disks.'."\n" .'* image_disk: The snapshot is used to create custom images and data disks.'."\n" .'* none: The snapshot is not used to create custom images or disks.'."\n", 'type' => 'string', 'example' => 'none', ], 'ResourceGroupId' => [ 'type' => 'string', ], 'LastModifiedTime' => [ 'title' => '快照的最后变更时间。按照ISO 8601标准表示，并使用 UTC +0 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。', 'type' => 'string', ], 'Tag' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'TagKey' => [ 'type' => 'string', ], 'TagValue' => [ 'type' => 'string', ], ], ], ], ], ], ], 'PageNumber' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '30', ], 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '9DAC759A-F4F0-5D02-8335-BC458C0CCB94', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '7', ], ], 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'InvalidUserAccount.NotSupported', 'errorMessage' => 'the Specified user account Validated not supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Snapshots\\": [\\n {\\n \\"Available\\": true,\\n \\"Category\\": \\"Standard\\",\\n \\"CreationTime\\": \\"2024-10-18T09:37:14Z\\",\\n \\"Description\\": \\"zd_test\\",\\n \\"Encrypted\\": true,\\n \\"InstantAccess\\": true,\\n \\"Progress\\": \\"100\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"SnapshotId\\": \\"rcds-hc1zg51xobdg4****\\",\\n \\"SnapshotName\\": \\"csw-37-系统盘\\",\\n \\"SnapshotType\\": \\"auto\\",\\n \\"SourceDiskId\\": \\"rcd-bp67acfmxazb4ph****\\",\\n \\"SourceDiskSize\\": 60,\\n \\"SourceDiskType\\": \\"data\\",\\n \\"SourceStorageType\\": \\"disk\\",\\n \\"Status\\": \\"progressing\\",\\n \\"Usage\\": \\"none\\",\\n \\"ResourceGroupId\\": \\"rc-t8q22a87745hf8****\\",\\n \\"LastModifiedTime\\": \\"\\",\\n \\"Tag\\": [\\n {\\n \\"TagKey\\": \\"testRC\\",\\n \\"TagValue\\": \\"test01\\"\\n }\\n ]\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"RequestId\\": \\"9DAC759A-F4F0-5D02-8335-BC458C0CCB94\\",\\n \\"TotalCount\\": 7\\n}","type":"json"}]', 'title' => 'DescribeRCSnapshots', ], 'DetachRCDisk' => [ 'summary' => 'Detaches a pay-as-you-go data disk or a system disk from an RDS Custom instance.', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rc-dh2jf9n6j4s14926****', ], ], [ 'name' => 'DiskId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the disk that you want to detach.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rcd-f8zh55g5gbk1byjr****', ], ], [ 'name' => 'DeleteWithInstance', 'in' => 'query', 'schema' => [ 'description' => 'The reserved parameter. This parameter is not supported.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'C8E88DED-533F-4B3C-9207-731FBF394CCA', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'InvalidUserAccount.NotSupported', 'errorMessage' => 'the Specified user account Validated not supported.', ], [ 'errorCode' => 'IncorrectInstanceStatus', 'errorMessage' => 'The current status of the resource does not support this operation.', ], [ 'errorCode' => 'IncorrectInstanceStatus.Initializing', 'errorMessage' => 'The specified instance status does not support this operation.', ], [ 'errorCode' => 'InvalidDevice.Malformed', 'errorMessage' => 'The specified device is not valid.', ], [ 'errorCode' => 'InvalidInstanceType.NotSupportDiskCategory', 'errorMessage' => 'The instanceType of the specified instance does not support this disk category.', ], [ 'errorCode' => 'InvalidEEDDisk.NotSupport', 'errorMessage' => 'The specified eed category does not support this operation.', ], [ 'errorCode' => 'InvalidDisk.CategoryFormat', 'errorMessage' => 'The specified eed category does not support this operation.', ], [ 'errorCode' => 'InvalidSnapshot.Malformed', 'errorMessage' => 'The specified eed category does not support snapshot operation.', ], [ 'errorCode' => 'OperationDenied.TimeLimit', 'errorMessage' => 'The interval between the two conversion operations must be greater than 15 minutes.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], [ 'errorCode' => 'DiskCategory.OperationNotSupported', 'errorMessage' => 'The type of the specified disk does not support creating a snapshot.', ], [ 'errorCode' => 'IncorrectDiskStatus.CreatingSnapshot', 'errorMessage' => 'A previous snapshot creation is in process.', ], [ 'errorCode' => 'IncorrectInstanceStatus.NotSupportESSD', 'errorMessage' => 'The operation is not supported in this status, please reboot the instance.', ], [ 'errorCode' => 'InvalidDiskCategory.NotSupported', 'errorMessage' => 'The specified disk category is not support the specified instance type.', ], [ 'errorCode' => 'InvalidOperation.InstanceTypeNotSupport', 'errorMessage' => 'The instance type of the specified instance does not support hot detach disk.', ], [ 'errorCode' => 'OperationDenied.DiskCreatingSnapshot', 'errorMessage' => 'The operation is denied due to a snapshot of the specified disk is not completed yet.', ], [ 'errorCode' => 'OperationDenied.DiskTypeViolation', 'errorMessage' => 'The specified disk is a system disk and cannot support the operation.', ], [ 'errorCode' => 'OperationDenied.IncorrectDiskStatus', 'errorMessage' => 'The current disk status does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C8E88DED-533F-4B3C-9207-731FBF394CCA\\"\\n}","type":"json"}]', 'title' => 'DetachRCDisk', ], 'DeleteRCSnapshot' => [ 'summary' => 'Deletes a cloud disk snapshot.', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'high', 'chargeType' => 'paid', ], 'parameters' => [ [ 'name' => 'SnapshotId', 'in' => 'query', 'schema' => [ 'description' => 'The snapshot ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rcds-7mbefjzkqccvdev****', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'Force', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to forcefully delete the snapshot that is used to create cloud disks. Valid values:'."\n" ."\n" .'* **true**: forcefully deletes the snapshot After the snapshot is forcefully deleted, the cloud disks created from the snapshot cannot be re-initialized.'."\n" .'* **false**(default): does not forcefully delete the snapshot.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The information returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '8BE834C8-3C25-5AF8-BE3E-C8A690602A7F', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'InvalidUserAccount.NotSupported', 'errorMessage' => 'the Specified user account Validated not supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8BE834C8-3C25-5AF8-BE3E-C8A690602A7F\\"\\n}","type":"json"}]', 'title' => 'DeleteRCSnapshot', 'description' => 'Before you call this operation, take note of the following items:'."\n" ."\n" .'* If the specified snapshot ID does not exist, the request will be ignored.'."\n" .'* If the snapshot is used to create custom images, the snapshot cannot be deleted. You must delete the created custom images before you can delete the snapshot.'."\n" .'* If the snapshot is used to create cloud disks and `Force` is not specified or is set to `false`, the snapshot cannot be directly deleted. If you want to delete the snapshot, set `Force` to true to forcefully delete the snapshot. The cloud disks created from the snapshot cannot be re-initialized after the snapshot is forcefully deleted.'."\n", ], 'CreateRCSnapshot' => [ 'summary' => 'Creates a snapshot for a cloud disk.', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'high', 'chargeType' => 'paid', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'DiskId', 'in' => 'query', 'schema' => [ 'description' => 'The cloud disk ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rcd-wz9f3peueu5npsl****', 'docRequired' => true, ], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => [ 'description' => 'The snapshot description. The description must be 2 to 256 characters in length and cannot start with `http://` or `https://`.'."\n" ."\n" .'By default, this parameter is left empty.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', ], ], [ 'name' => 'ZoneId', 'in' => 'query', 'schema' => [ 'description' => 'This parameter has been deprecated.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-b', ], ], [ 'name' => 'InstantAccess', 'in' => 'query', 'schema' => [ 'description' => 'This parameter is deprecated.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'none', ], ], [ 'name' => 'InstantAccessRetentionDays', 'in' => 'query', 'schema' => [ 'description' => 'This parameter is deprecated.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => 'none', ], ], [ 'name' => 'RetentionDays', 'in' => 'query', 'schema' => [ 'description' => 'The retention period of the snapshot. Valid values: 1 to 65536. Unit: days. The snapshot is automatically released when its retention period expires.'."\n" ."\n" .'By default, this parameter is left empty, which specifies that the snapshot is not automatically released.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', ], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Key' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'None', ], 'Value' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'None', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 21, ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'None', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'CE93CC0D-B65D-5723-AAB1-08CB8BBABAB9', ], 'SnapshotId' => [ 'description' => 'The snapshot ID.'."\n", 'type' => 'string', 'example' => 'rcds-7mbefjzkqccvdev****', ], ], 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'InvalidUserAccount.NotSupported', 'errorMessage' => 'the Specified user account Validated not supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], [ 'errorCode' => 'IncorrectDiskStatus.CreatingSnapshot', 'errorMessage' => 'A previous snapshot creation is in process.', ], [ 'errorCode' => 'CreateSnapshot.Failed', 'errorMessage' => 'The process of creating rc snapshot is failed.', ], [ 'errorCode' => 'DiskCategory.OperationNotSupported', 'errorMessage' => 'The type of the specified disk does not support creating a snapshot.', ], [ 'errorCode' => 'OperationDenied.IncorrectDiskStatus', 'errorMessage' => 'The current disk status does not support this operation.', ], [ 'errorCode' => 'QuotaExceed.Snapshot', 'errorMessage' => 'The snapshot quota exceeds.', ], [ 'errorCode' => 'IncorrectDiskStatus.NeverAttached', 'errorMessage' => 'The specified disk has never been attached to any instance.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CE93CC0D-B65D-5723-AAB1-08CB8BBABAB9\\",\\n \\"SnapshotId\\": \\"rcds-7mbefjzkqccvdev****\\"\\n}","type":"json"}]', 'title' => 'CreateRCSnapshot', 'description' => 'In the following scenarios, you cannot create snapshots for a specific disk:'."\n" ."\n" .'* The number of manual snapshots of the disk has reached 256.'."\n" .'* A snapshot is being created for the disk.'."\n" .'* The instance to which the disk is attached has never been started.'."\n" .'* The instance to which the disk is attached is not in the **Stopped** or **Running** state.'."\n" ."\n" .'When you create a snapshot, take note of the following items:'."\n" ."\n" .'* If a snapshot is being created, the snapshot cannot be used to create a custom image by calling the CreateImage operation.'."\n" .'* When a snapshot is being created for a disk that is attached to an RDS Custom instance, do not change the instance state.'."\n" .'* You can create snapshots for a disk that is in the **Expired** state. If the release time scheduled for a disk arrives when a snapshot is being created for the disk, the snapshot in the Creating state is deleted when the disk is released.'."\n", ], 'DescribeRCDisks' => [ 'summary' => 'Queries the disk information about an RDS Custom instance.', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rc-dh2jf9n6j4s14926****', ], ], [ 'name' => 'DiskIds', 'in' => 'query', 'schema' => [ 'description' => 'The disk ID. The value is a JSON array that consists of up to 100 disk IDs. Separate the disk IDs with commas (,). Format: `["Disk ID1","Disk ID2"]`.'."\n", 'type' => 'string', 'required' => false, 'example' => '["rcd-bp67acfmxazb4p****", "rcd-bp67acfmxazb4g****", … "rcd-bp67acfmxazb4d****"]', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page. Valid values: **30** to **100**. Default value: **30**.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '50', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The list of the tags.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The tags'."\n", 'type' => 'object', 'properties' => [ 'Key' => [ 'description' => 'The key of the tag. The tag key **cannot be** an empty string or a duplicate value.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testkey1', ], 'Value' => [ 'description' => 'The value of the tag. The tag value **can be** an empty string.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testvalue1', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 21, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Disks' => [ 'description' => 'The information about the disks.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the disk.'."\n", 'type' => 'object', 'properties' => [ 'Category' => [ 'description' => 'The category of the disk. Valid values:'."\n" ."\n" .'* **cloud_efficiency**: ultra disk.'."\n" .'* **cloud_ssd**: standard SSD.'."\n" .'* **cloud_essd**: ESSD.'."\n" .'* **cloud_auto**: Premium ESSD'."\n", 'type' => 'string', 'example' => 'cloud_ssd', ], 'CreationTime' => [ 'description' => 'The creation time.'."\n", 'type' => 'string', 'example' => '2024-10-22T02:41:37Z', ], 'DeleteAutoSnapshot' => [ 'description' => 'Indicates whether the automatic snapshots of the cloud disk are deleted after the disk is released. Valid values:'."\n" ."\n" .'* true'."\n" .'* false'."\n", 'type' => 'boolean', 'example' => 'true', ], 'DeleteWithInstance' => [ 'description' => 'Indicates whether the cloud disk is released when its associated instance is released. Valid values:'."\n" ."\n" .'* true'."\n" .'* false'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Description' => [ 'description' => 'The disk description.'."\n", 'type' => 'string', 'example' => 'zd_test', ], 'Device' => [ 'description' => 'The mount point of the disk.'."\n", 'type' => 'string', 'example' => '/dev/xvda', ], 'DiskChargeType' => [ 'description' => 'The billing method of the disk.'."\n" ."\n" .'Only **PostPaid** (pay-as-you-go) is supported.'."\n", 'type' => 'string', 'example' => 'PostPaid', ], 'DiskId' => [ 'description' => 'The disk ID.'."\n", 'type' => 'string', 'example' => 'rcd-wz9f3peueu5npsl****', ], 'DiskName' => [ 'description' => 'The disk name.'."\n", 'type' => 'string', 'example' => 'fvt-ecs-bcfb3627', ], 'Encrypted' => [ 'description' => 'Indicates whether only encrypted cloud disks are queried. Valid values:'."\n" ."\n" .'* true'."\n" .'* false (default)'."\n", 'type' => 'boolean', 'example' => 'true', ], 'ExpiredTime' => [ 'description' => 'A reserved parameter. You do not need to specify this parameter.'."\n", 'type' => 'string', 'example' => 'none', ], 'IOPS' => [ 'description' => 'The provisioned read/write IOPS of the ESSD AutoPL disk. Valid values: 0 to min{50,000, 1,000 × *Capacity - Baseline performance}. Baseline performance = min{1,800 + 50 × *Capacity, 50,000}'."\n" ."\n" .'This parameter is available only when the `Category` parameter is set to `cloud_auto`.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '4000', ], 'ImageId' => [ 'description' => 'The ID of the image that is used to create the instance. This parameter is returned only if the cloud disk is created from an image. The value of this parameter remains unchanged throughout the lifecycle of the cloud disk.'."\n", 'type' => 'string', 'example' => 'm-2zeb24dw6wripjn2****', ], 'InstanceId' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rc-e8w1cn7634kiam****', ], 'PerformanceLevel' => [ 'description' => 'The performance level (PL) of the ESSD. Valid values:'."\n" ."\n" .'* PL0: A single ESSD can deliver up to 10,000 random read/write IOPS.'."\n" .'* PL1: A single ESSD can deliver up to 50,000 random read/write IOPS.'."\n" .'* PL2: A single ESSD can deliver up to 100,000 random read/write IOPS.'."\n" .'* PL3: A single ESSD can deliver up to 1,000,000 random read/write IOPS.'."\n", 'type' => 'string', 'example' => 'PL0', ], 'RegionId' => [ 'description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], 'ResourceGroupId' => [ 'description' => 'The ID of the resource group to which the disk belongs.'."\n", 'type' => 'string', 'example' => 'rg-aekzescnje5khnq', ], 'SerialNumber' => [ 'description' => 'The serial number of the disk.'."\n", 'type' => 'string', 'example' => 'bp18um4r4f2fve2****', ], 'Size' => [ 'description' => 'The size of the disk. Unit: GiB.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '60', ], 'SourceSnapshotId' => [ 'description' => 'The ID of the snapshot that was used to create the cloud disk.'."\n" ."\n" .'This parameter is empty unless the cloud disk was created from a snapshot. The value of this parameter remains unchanged throughout the lifecycle of the cloud disk.'."\n", 'type' => 'string', 'example' => 'rcds-bp67acfmxazb4p****', ], 'Status' => [ 'description' => 'The status of the disk. Valid values:'."\n" ."\n" .'* In_use: The disk is in use.'."\n" .'* Available: The disk can be attached.'."\n" .'* Attaching: The disk is being attached.'."\n" .'* Detaching: The cloud disk is being detached.'."\n" .'* Creating: The disk is being created.'."\n" .'* ReIniting: The disk is being initialized.'."\n", 'type' => 'string', 'example' => 'In_use', ], 'StorageClusterId' => [ 'description' => 'The ID of the dedicated block storage cluster to which the cloud disk belongs. If your cloud disk belongs to the public block storage cluster, an empty value is returned.'."\n", 'type' => 'string', 'example' => 'dbsc-cn-zvp2rl601****', ], 'StorageSetId' => [ 'description' => 'The storage set ID.'."\n", 'type' => 'string', 'example' => 'ss-i-bp1j4i2jdf3owlhe****', ], 'Type' => [ 'description' => 'The disk type. Valid values:'."\n" ."\n" .'* system: system disk'."\n" .'* data: data disk'."\n", 'type' => 'string', 'example' => 'data', ], 'ZoneId' => [ 'description' => 'The zone ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou-j', ], 'Tag' => [ 'description' => 'The list of tags.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The tags.'."\n", 'type' => 'object', 'properties' => [ 'TagKey' => [ 'description' => 'The tag key.'."\n", 'type' => 'string', 'example' => 'testkey1', ], 'TagValue' => [ 'description' => 'The tag value.'."\n", 'type' => 'string', 'example' => 'testvalue1'."\n", ], ], ], ], 'AttachedTime' => [ 'title' => '挂载时间。', 'type' => 'string', 'example' => '2017-12-05T2340:00Z', ], 'BurstingEnabled' => [ 'title' => '是否开启 Burst（性能突发）。可能值：'."\n" ."\n" .'true：是。'."\n" .'false：否。'."\n" .'当DiskCategory取值为cloud_auto时才支持设置该参数。更多信息，请参见ESSD AutoPL 云盘。', 'type' => 'boolean', ], 'Portable' => [ 'title' => '磁盘是否可卸载。', 'type' => 'boolean', ], ], ], ], 'PageNumber' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '30', ], 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '8B993DA9-5272-5414-94E3-4CA8BA0146C2', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '12', ], ], 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'InvalidUserAccount.NotSupported', 'errorMessage' => 'the Specified user account Validated not supported.', ], [ 'errorCode' => 'InvalidParameter.InstanceIds', 'errorMessage' => 'The specified parameter InstanceIds is invalid.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Disks\\": [\\n {\\n \\"Category\\": \\"cloud_auto\\",\\n \\"CreationTime\\": \\"2024-10-22T02:41:37Z\\",\\n \\"DeleteAutoSnapshot\\": true,\\n \\"DeleteWithInstance\\": true,\\n \\"Description\\": \\"zd_test\\",\\n \\"Device\\": \\"/dev/xvda\\",\\n \\"DiskChargeType\\": \\"PostPaid\\",\\n \\"DiskId\\": \\"rcd-wz9f3peueu5npsl****\\",\\n \\"DiskName\\": \\"fvt-ecs-bcfb3627\\",\\n \\"Encrypted\\": true,\\n \\"ExpiredTime\\": \\"none\\",\\n \\"IOPS\\": 4000,\\n \\"ImageId\\": \\"m-2zeb24dw6wripjn2****\\",\\n \\"InstanceId\\": \\"rc-e8w1cn7634kiam****\\",\\n \\"PerformanceLevel\\": \\"PL0\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ResourceGroupId\\": \\"rg-aekzescnje5khnq\\",\\n \\"SerialNumber\\": \\"bp18um4r4f2fve2****\\",\\n \\"Size\\": 60,\\n \\"SourceSnapshotId\\": \\"rcds-bp67acfmxazb4p****\\",\\n \\"Status\\": \\"In_use\\",\\n \\"StorageClusterId\\": \\"dbsc-cn-zvp2rl601****\\",\\n \\"StorageSetId\\": \\"ss-i-bp1j4i2jdf3owlhe****\\",\\n \\"Type\\": \\"data\\",\\n \\"ZoneId\\": \\"cn-hangzhou-j\\",\\n \\"Tag\\": [\\n {\\n \\"TagKey\\": \\"testkey1\\",\\n \\"TagValue\\": \\"testvalue1\\\\n\\"\\n }\\n ],\\n \\"AttachedTime\\": \\"2017-12-05T2340:00Z\\",\\n \\"BurstingEnabled\\": true,\\n \\"Portable\\": true\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"RequestId\\": \\"8B993DA9-5272-5414-94E3-4CA8BA0146C2\\",\\n \\"TotalCount\\": 12\\n}","type":"json"}]', 'title' => 'DescribeRCDisks', ], 'DeleteRCDisk' => [ 'summary' => 'Releases a pay-as-you-go data disk. The data disk can be a basic disk, an ultra disk, a standard SSD, or an Enterprise SSD (ESSD).', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'high', 'chargeType' => 'paid', ], 'parameters' => [ [ 'name' => 'DiskId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the cloud disk that you want to release.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rcd-wz9c8isqly8637zw****', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The information returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '8BE834C8-3C25-5AF8-BE3E-C8A690602A7F', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'InvalidUserAccount.NotSupported', 'errorMessage' => 'the Specified user account Validated not supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], [ 'errorCode' => 'IncorrectDiskStatus.CreatingSnapshot', 'errorMessage' => 'A previous snapshot creation is in process.', ], [ 'errorCode' => 'OperationDenied.IncorrectDiskStatus', 'errorMessage' => 'The current disk status does not support this operation.', ], [ 'errorCode' => 'OperationDenied.DiskCreatingSnapshot', 'errorMessage' => 'The operation is denied due to a snapshot of the specified disk is not completed yet.', ], [ 'errorCode' => 'OperationDenied.DiskTypeViolation', 'errorMessage' => 'The specified disk is a system disk and cannot support the operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8BE834C8-3C25-5AF8-BE3E-C8A690602A7F\\"\\n}","type":"json"}]', 'title' => 'DeleteRCDisk', 'description' => 'Before you call this operation, take note of the following items:'."\n" ."\n" .'* Manual snapshots of the disk are retained.'."\n" .'* The disk must be in the Unattached (Available) state.'."\n" .'* If no disk with the specified disk ID exists, the request will be ignored.'."\n", ], 'AttachRCDisk' => [ 'summary' => 'Attaches a pay-as-you-go data disk or a system disk to an RDS Custom instance. The instance and the disk must reside in the same zone.', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'high', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'rc-dh2jf9n6j4s14926****', ], ], [ 'name' => 'DiskId', 'in' => 'query', 'schema' => [ 'description' => 'The disk ID.', 'type' => 'string', 'required' => true, 'example' => 'rcd-wz98hnpj2sjo85zc7t2w', ], ], [ 'name' => 'DeleteWithInstance', 'in' => 'query', 'schema' => [ 'description' => 'The reserved parameter. This parameter is not supported.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'C19D1668-70CB-5421-AA91-D6D8EE3AB664', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'InvalidUserAccount.NotSupported', 'errorMessage' => 'the Specified user account Validated not supported.', ], [ 'errorCode' => 'InvalidInstanceType.NotSupportDiskCategory', 'errorMessage' => 'The instanceType of the specified instance does not support this disk category.', ], [ 'errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'InstanceId is invalid, not found.', ], [ 'errorCode' => 'IncorrectInstanceStatus', 'errorMessage' => 'The current status of the resource does not support this operation.', ], [ 'errorCode' => 'IncorrectInstanceStatus.Initializing', 'errorMessage' => 'The specified instance status does not support this operation.', ], [ 'errorCode' => 'InvalidDevice.Malformed', 'errorMessage' => 'The specified device is not valid.', ], [ 'errorCode' => 'InvalidOperation.OtherInstanceUnsupported', 'errorMessage' => 'The elastic ephemeral disk can only be attached to the instance it was last mounted on, please check the disk\'s system tag to get the last associated instance.', ], [ 'errorCode' => 'Invalid.RCInstanceExpired', 'errorMessage' => 'The requested custom instance has expired.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], [ 'errorCode' => 'IncorrectInstanceStatus.NotSupportESSD', 'errorMessage' => 'The operation is not supported in this status, please reboot the instance.', ], [ 'errorCode' => 'InvalidOperation.InstanceTypeNotSupport', 'errorMessage' => 'The instance type of the specified instance does not support hot detach disk.', ], [ 'errorCode' => 'OperationDenied.InstanceDiskLimitExceeded', 'errorMessage' => 'The amount of the disk on instance in question reach its limits.', ], [ 'errorCode' => 'DiskCategory.OperationNotSupported', 'errorMessage' => 'The type of the specified disk does not support creating a snapshot.', ], [ 'errorCode' => 'IncorrectDiskStatus.CreatingSnapshot', 'errorMessage' => 'A previous snapshot creation is in process.', ], [ 'errorCode' => 'InvalidDiskCategory.NotSupported', 'errorMessage' => 'The specified disk category is not support the specified instance type.', ], [ 'errorCode' => 'OperationDenied.DiskCreatingSnapshot', 'errorMessage' => 'The operation is denied due to a snapshot of the specified disk is not completed yet.', ], [ 'errorCode' => 'OperationDenied.IncorrectDiskStatus', 'errorMessage' => 'The current disk status does not support this operation.', ], [ 'errorCode' => 'ResourcesNotInSameZone', 'errorMessage' => 'The specified instance and disk are not in the same zone.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C19D1668-70CB-5421-AA91-D6D8EE3AB664\\"\\n}","type":"json"}]', 'title' => 'AttachRCDisk', ], 'DescribeRCClusterConfig' => [ 'summary' => 'Queries the kubeconfig file of a Container Service for Kubernetes (ACK) cluster in which an RDS Custom instance resides.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'docRequired' => true, ], ], [ 'name' => 'VpcId', 'in' => 'query', 'schema' => [ 'description' => 'The virtual private cloud (VPC) ID.'."\n" ."\n" .'> This is a reserved parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'None', ], ], [ 'name' => 'TemporaryDurationMinutes', 'in' => 'query', 'schema' => [ 'description' => 'The validity period of the temporary kubeconfig file. Unit: minutes. Valid values: 15 to 4320.'."\n" ."\n" .'> If you do not specify this parameter, the system specifies a longer validity period. The validity period is returned in the `expiration` parameter.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The message returned.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'E9DD55F4-1A5F-48CA-BA57-DFB3CA8C4C34', ], 'Config' => [ 'description' => 'The kubeconfig file of the cluster.'."\n", 'type' => 'string', 'example' => 'apiVersion: v1****', ], 'Expiration' => [ 'description' => 'The expiration time of the kubeconfig file. Format: the UTC time in the RFC3339 format.'."\n", 'type' => 'string', 'example' => '2024-03-10T09:56:17Z', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'InvalidUserAccount.NotSupported', 'errorMessage' => 'the Specified user account Validated not supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E9DD55F4-1A5F-48CA-BA57-DFB3CA8C4C34\\",\\n \\"Config\\": \\"apiVersion: v1****\\",\\n \\"Expiration\\": \\"2024-03-10T09:56:17Z\\"\\n}","type":"json"}]', 'title' => 'DescribeRCClusterConfig', 'description' => 'Kubeconfig files store identity and authentication information that is used by clients to access ACK clusters. To use kubectl to manage an ACK cluster, you must use the kubeconfig file to connect to the ACK cluster. We recommend that you keep kubeconfig files confidential and revoke kubeconfig files that are not in use. This helps prevent data leaks caused by the disclosure of kubeconfig files.'."\n", ], 'AttachRCInstances' => [ 'summary' => 'Adds RDS Custom nodes to a Container Service for Kubernetes (ACK) cluster.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'VpcId', 'in' => 'query', 'schema' => [ 'description' => 'The virtual private cloud (VPC) ID.'."\n" ."\n" .'> This is a reserved parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'None', ], ], [ 'name' => 'InstanceIds', 'in' => 'query', 'style' => 'simple', 'schema' => [ 'description' => 'The node IDs.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The node ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rc-e2g521l55k038cr8****', ], 'required' => true, ], ], [ 'name' => 'Password', 'in' => 'query', 'schema' => [ 'description' => 'The logon password of the node.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testPassword', ], ], [ 'name' => 'KeyPair', 'in' => 'query', 'schema' => [ 'description' => 'The key pair of the node.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Custom_test'."\n", ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '847BA085-B377-4BFA-8267-F82345ECE1D2', ], 'Responses' => [ 'description' => 'The response parameters.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'Code' => [ 'description' => 'The HTTP status code returned.'."\n", 'type' => 'string', 'example' => '200', ], 'InstanceId' => [ 'description' => 'The node ID.'."\n", 'type' => 'string', 'example' => 'rc-e2g521l55k038cr8****', ], 'Message' => [ 'description' => 'The message returned.'."\n" ."\n" .'> If the request is successful, **Successful** is returned. If the request fails, an error message that contains information such as an error code is returned.'."\n", 'type' => 'string', 'example' => 'Successful', ], ], ], ], 'TaskId' => [ 'description' => 'The task ID.'."\n", 'type' => 'string', 'example' => '178968983', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'InvalidUserAccount.NotSupported', 'errorMessage' => 'the Specified user account Validated not supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"847BA085-B377-4BFA-8267-F82345ECE1D2\\",\\n \\"Responses\\": [\\n {\\n \\"Code\\": \\"200\\",\\n \\"InstanceId\\": \\"rc-e2g521l55k038cr8****\\",\\n \\"Message\\": \\"Successful\\"\\n }\\n ],\\n \\"TaskId\\": \\"178968983\\"\\n}","type":"json"}]', 'title' => 'AttachRCInstances', ], 'DeleteRCClusterNodes' => [ 'summary' => 'Deletes a RDS Custom node from a Container Service for Kubernetes (ACK) cluster.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'VpcId', 'in' => 'query', 'schema' => [ 'description' => 'The virtual private cloud (VPC) ID.'."\n" ."\n" .'> This is a reserved parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'None', ], ], [ 'name' => 'Nodes', 'in' => 'query', 'style' => 'simple', 'schema' => [ 'description' => 'The node information.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about a node.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou.20.8.XXX.XXX', ], 'required' => false, ], ], [ 'name' => 'InstanceIds', 'in' => 'query', 'style' => 'simple', 'schema' => [ 'description' => 'The instance IDs.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rm-2ze1f6k06tzr7****', ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '7E0970A1-0434-5C83-B560-613EBA11B525', ], 'TaskId' => [ 'description' => 'The task ID.'."\n", 'type' => 'string', 'example' => '238028563', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'InvalidUserAccount.NotSupported', 'errorMessage' => 'the Specified user account Validated not supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7E0970A1-0434-5C83-B560-613EBA11B525\\",\\n \\"TaskId\\": \\"238028563\\"\\n}","type":"json"}]', 'title' => 'DeleteRCClusterNodes', ], 'ModifyDBInstanceReplicationSwitch' => [ 'summary' => 'Enables or disables the native replication feature of ApsaraDB RDS for MySQL.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-bp*****', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the instance. You can call the [DescribeRegions](~~26243~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'ExternalReplication', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable the native replication feature. Valid values:'."\n" ."\n" .'* **ON**'."\n" .'* **OFF**'."\n", 'type' => 'string', 'required' => true, 'example' => 'ON', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The resource group ID. You can leave this parameter empty.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '9F8C06AD-3F37-57A0-ABBF-ABD7824F55CE', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9F8C06AD-3F37-57A0-ABBF-ABD7824F55CE\\"\\n}","type":"json"}]', 'title' => 'ModifyDBInstanceReplicationSwitch', 'description' => 'If you want to enable the native replication feature for an ApsaraDB RDS for MySQL instance, the following requirements must be met:'."\n" ."\n" .'* The RDS instance runs MySQL 5.7.'."\n" .'* The RDS instance runs RDS Basic Edition.'."\n" .'* The RDS instance uses the pay-as-you-go or subscription billing method.'."\n" .'* The RDS instance runs a minor engine version of 20240930 or later.'."\n" ."\n" .'For more information, see [Enable the native replication feature](~~2856530~~).'."\n", ], 'DescribeDBInstanceReplication' => [ 'summary' => 'Queries the status and configurations of a native replication instance.', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-uf6wjk5****', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The resource group ID. You can leave this parameter empty.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmx****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '847BA085-B377-4BFA-8267-F82345ECE1D2', ], 'ExternalReplication' => [ 'description' => 'Indicates whether the native replication mods is enabled. Valid values:'."\n" ."\n" .'* **ON**'."\n" .'* **OFF**'."\n", 'type' => 'string', 'example' => 'ON', ], 'ReplicationSource' => [ 'description' => 'The source of the native replication.'."\n", 'type' => 'string', 'example' => '192.168.x.x', ], 'ReplicationState' => [ 'description' => 'The current replication status. Valid values:'."\n" ."\n" .'* **Running**'."\n" .'* **Connecting**'."\n" .'* **Stopped**'."\n" .'* **Error**'."\n", 'type' => 'string', 'example' => 'Running'."\n" .'Connecting'."\n" .'Stopped'."\n" .'Error', ], 'ReplicationDelay' => [ 'description' => 'The replication latency. Unit: seconds.'."\n", 'type' => 'string', 'example' => '0', ], 'ReplicationErrorMessage' => [ 'description' => 'The replication error message.'."\n", 'type' => 'string', 'example' => 'Got fatal error 1236 from master when reading data from binary log...', ], 'ReplicationIp' => [ 'type' => 'string', ], 'ReplicationPort' => [ 'type' => 'string', ], 'GtidExecuted' => [ 'title' => '已执行的全局事务标识符', 'type' => 'string', ], 'ImportStatus' => [ 'title' => '导入状态，是否成功导入全量数据', 'type' => 'string', 'example' => 'COMPLETED', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"847BA085-B377-4BFA-8267-F82345ECE1D2\\",\\n \\"ExternalReplication\\": \\"ON\\",\\n \\"ReplicationSource\\": \\"192.168.XX.XX\\",\\n \\"ReplicationState\\": \\"Stopped\\",\\n \\"ReplicationDelay\\": \\"0\\",\\n \\"ReplicationErrorMessage\\": \\"Got fatal error 1236 from master when reading data from binary log...\\",\\n \\"ReplicationIp\\": \\"192.168.10.x\\",\\n \\"ReplicationPort\\": \\"3306\\",\\n \\"GtidExecuted\\": \\"bd2a34b9-8b8d-11ef-8917-00163e1298b9:1-20567\\",\\n \\"ImportStatus\\": \\"COMPLETED\\"\\n}","type":"json"}]', 'title' => 'DescribeDBInstanceReplication', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'MySQL'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> Before you call this operation, read the following topics and make sure that you fully understand the prerequisites and impacts of this operation.'."\n" ."\n" .'[ApsaraDB RDS for MySQL native replication instances](~~2856487~~)'."\n", ], 'MigrateDBNodes' => [ 'summary' => 'Changes the zone of a node from an ApsaraDB RDS for MySQL instance that runs RDS Cluster Edition.', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'Specifies the client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCz****', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the [DescribeDBInstances](~~26232~~) operation to query the IDs of instances.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-t4n3a****', ], ], [ 'name' => 'DBNode', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The details of the nodes.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details of the node.'."\n", 'type' => 'object', 'properties' => [ 'zoneId' => [ 'description' => 'The ID of the zone in which the node resides.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-f', ], 'nodeId' => [ 'description' => 'The node ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rn-6256r4a87xvv7****', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 7, 'minItems' => 1, ], ], [ 'name' => 'EffectiveTime', 'in' => 'query', 'schema' => [ 'description' => 'The time when you want the system to start the migration. Valid value:'."\n" ."\n" .'* **Immediately**: The system immediately starts the migration. This is the default value.'."\n" .'* **MaintainTime**: The system starts the migration during the specified maintenance window.'."\n" .'* **Specified**: The system starts the migration at the specified point in time.'."\n", 'type' => 'string', 'required' => false, 'example' => 'MaintainTime', ], ], [ 'name' => 'VSwitchId', 'in' => 'query', 'schema' => [ 'description' => 'The vSwitch ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vsw-****', ], ], [ 'name' => 'SwitchTime', 'in' => 'query', 'schema' => [ 'description' => 'Specifies the time when the modification is performed. We recommend that you apply the specification during off-peak hours. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => false, 'example' => '2022-05-06T09:24:00Z', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '8B993DA9-5272-5414-94E3-4CA8BA0146C2', ], 'DBInstanceId' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-uf64oq9381l03w1qp', ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'DBNodeFormatFault', 'errorMessage' => 'The specified parameter DBNode is malformed', ], [ 'errorCode' => 'DBNodeParameterRequired', 'errorMessage' => 'The specified parameter DBNode is required.', ], [ 'errorCode' => 'DBNodeIdParameter.NotExists', 'errorMessage' => 'The specified DBNodeId is not existed.', ], [ 'errorCode' => 'SecondaryClassCode.Unsupported', 'errorMessage' => 'At least one secondary node has the same classCode as the primary node.', ], [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'The current instance state does not support this operation.', ], [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The specified DB instance name does not exist.', ], [ 'errorCode' => 'InvalidNodeId', 'errorMessage' => 'Parameter node id is not valid.', ], [ 'errorCode' => 'SlaveClassCode.Unsupported', 'errorMessage' => 'Need at least one secondary\'s class_code same as primary\'s.', ], [ 'errorCode' => 'InvalidDBInstanceStorage', 'errorMessage' => 'The specified DBInstanceStorage is invalid.', ], [ 'errorCode' => 'UnsupportedOperationDirection.DiskUpgrade', 'errorMessage' => 'The specified operation is not allowed, class and storage can only modify to one direction, current class: DOWNGRADE.', ], [ 'errorCode' => 'UnsupportedOperationDirection.DiskDowngrade', 'errorMessage' => 'The specified operation is not allowed, class and storage can only modify to one direction, current class: UPGRADE', ], [ 'errorCode' => 'InvalidDBInstanceStorageType', 'errorMessage' => 'The specified DBInstanceStorageType is invalid.', ], [ 'errorCode' => 'InvalidMultiTenant', 'errorMessage' => 'Multi tenants cannot exist in a same instance.', ], [ 'errorCode' => 'DBNodeParameter.InvalidCombination', 'errorMessage' => 'DBNode class code combination is not valid.', ], [ 'errorCode' => 'InvalidClassCode', 'errorMessage' => 'The specification code in the parameter is invalid.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'InvalidSaleComponentFault', 'errorMessage' => 'The request not refer to the correct order sale component. please contact customer service.', ], [ 'errorCode' => 'OperationDenied.DBType', 'errorMessage' => 'The operation is not permitted due to type of the database.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance does not exist or is not supported.', ], [ 'errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'Current cluster resources are insufficient. Try again later.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8B993DA9-5272-5414-94E3-4CA8BA0146C2\\",\\n \\"DBInstanceId\\": \\"rm-uf64oq9381l03w1qp\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'MigrateDBNodes', ], 'SwitchOverMajorVersionUpgrade' => [ 'summary' => 'Performs a zero-downtime workload switchover after the major engine version upgrade of an ApsaraDB RDS for PostgreSQL instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the [DescribeRegions](~~610399~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'format' => 'byte', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => [ 'description' => 'The instance name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'pgm-m5e4gegx63fh92bn', ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'The type of the switchover operation. Valid values:'."\n" ."\n" .'* switch'."\n" .'* cancel'."\n" .'* interrupt'."\n", 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'cancel' => 'cancel', 'interrupt' => 'interrupt', 'switch' => 'switch', ], 'example' => 'switch', ], ], [ 'name' => 'SwitchoverTimeout', 'in' => 'query', 'schema' => [ 'description' => 'The timeout period for the switchover operation. The operation is canceled after it has been performed for a time period that exceeds the value. Unit: seconds. Valid value: 10 to 3600.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '3600', 'minimum' => '10', 'example' => '10', 'default' => '60', ], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'type' => 'string', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'type' => 'string', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request'."\n", 'type' => 'string', 'example' => '17F57FEE-EA4F-4337-8D2E-9C23CAA63D74', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'NoAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for account. We recommend that you add a payment method.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"17F57FEE-EA4F-4337-8D2E-9C23CAA63D74\\"\\n}","type":"json"}]', 'title' => 'SwitchOverMajorVersionUpgrade', 'description' => 'Supported database engine'."\n" ."\n" .'* PostgreSQL'."\n", ], 'AssociateEipAddressWithRCInstance' => [ 'summary' => 'Associates an elastic IP address (EIP) with an RDS Custom instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rc-i322y2t562oh7o******'."\n", 'docRequired' => true, ], ], [ 'name' => 'AllocationId', 'in' => 'query', 'schema' => [ 'description' => 'The EIP ID.'."\n" ."\n" .'> If no EIP is available, create an EIP. For more information, see [Create an EIP](~~292841~~).'."\n", 'type' => 'string', 'required' => false, 'example' => 'eip-bp166out2x4bpcf******', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'EFFC7565-B3CF-5CFA-9E1F-164DD1E1F498', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'NoAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for account. We recommend that you add a payment method.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EFFC7565-B3CF-5CFA-9E1F-164DD1E1F498\\"\\n}","type":"json"}]', 'title' => 'AssociateEipAddressWithRCInstance', 'description' => '### [](#)Supported database engine'."\n" ."\n" .'SQL Server'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'[Introduction to ApsaraDB RDS Custom](~~2864363~~)'."\n" ."\n" .'### [](#)Precautions'."\n" ."\n" .'If the RDS Custom instance uses a public IP address, the public IP address is automatically released after you associate an EIP with the instance.'."\n", ], 'DescribeRCInstanceIpAddress' => [ 'summary' => 'Queries the protection information about an RDS Custom for SQL Server instance and the details of the Anti-DDoS Origin instance to which the RDS Custom instance is added.', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the region in which the RDS Custom instance resides.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', ], ], [ 'name' => 'InstanceType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the asset that is assigned a public IP address. Set the value to **ecs**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ecs', ], ], [ 'name' => 'DdosStatus', 'in' => 'query', 'schema' => [ 'description' => 'The DDoS mitigation status of the asset. Valid values:'."\n" ."\n" .'* **defense**: queries assets for which traffic scrubbing is performed.'."\n" .'* **blackhole**: queries assets for which blackhole filtering is triggered.'."\n", 'type' => 'string', 'required' => false, 'example' => 'defense', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the RDS Custom instance to which the asset to query is added.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rc-y6dn4pyuub1r89******', ], ], [ 'name' => 'InstanceIp', 'in' => 'query', 'schema' => [ 'description' => 'The IP address of the asset to query.'."\n", 'type' => 'string', 'required' => false, 'example' => '39.105.XXX.XXX', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => 'The page number. Default value: 1. Pages start from page 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of instances on each page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], [ 'name' => 'ResourceType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the resource. Set the value to **ecs**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ecs', ], ], [ 'name' => 'DdosRegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the asset.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'docRequired' => true, ], ], [ 'name' => 'InstanceName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the RDS Custom instance to which the asset to query is added.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rc-y6dn4pyuub1r89******', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'C048E440-EA84-5E97-8C81-2A7060D0****_th**', ], 'Total' => [ 'description' => 'The total number of the assets.'."\n", 'type' => 'string', 'example' => '1', ], 'RCInstanceList' => [ 'description' => 'An array that consists of details of the instance.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'InstanceId' => [ 'description' => 'The ID of the RDS Custom instance.'."\n", 'type' => 'string', 'example' => 'rc-kti8hw44yy0x53******', ], 'InstanceType' => [ 'description' => 'The type of the asset. The value is fixed to **ecs**.'."\n", 'type' => 'string', 'example' => 'ecs', ], 'InstanceName' => [ 'description' => 'The instance name.'."\n", 'type' => 'string', 'example' => 'rc-kti8hw44yy0x53******', ], 'InstanceStatus' => [ 'description' => 'The DDoS mitigation status of the instance. Valid values:'."\n" ."\n" .'* **normal**'."\n" .'* **abnormal**'."\n", 'type' => 'string', 'example' => 'normal', ], 'IpAddressConfig' => [ 'description' => 'An array that consists of the details of the asset.'."\n", 'type' => 'array', 'items' => [ 'description' => 'An array that consists of the details of the asset.'."\n", 'type' => 'object', 'properties' => [ 'InstanceIp' => [ 'description' => 'The IP address of the asset.'."\n", 'type' => 'string', 'example' => '39.105.XXX.XXX', ], 'IsBgppack' => [ 'description' => 'Indicates whether the asset is added to the instance. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'IpVersion' => [ 'description' => 'The IP version of the instance. Valid values:'."\n" ."\n" .'* **v4**'."\n" .'* **v6**'."\n", 'type' => 'string', 'example' => 'v4', ], 'IpStatus' => [ 'description' => 'The DDoS mitigation status of the asset. Valid values:'."\n" ."\n" .'* **mitigating**'."\n" .'* **blackholed**'."\n" .'* **normal**'."\n", 'type' => 'string', 'example' => 'normal', ], 'RegionId' => [ 'description' => 'The region code of the asset.'."\n", 'type' => 'string', 'example' => 'cn-beijing-wt97-a01', ], 'ElasticThreshold' => [ 'description' => 'The burstable protection threshold for the asset. Unit: Mbit/s.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '12310', ], 'BlackholeThreshold' => [ 'description' => 'The basic protection threshold for the asset. Unit: Mbit/s.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5200', ], 'DefenseBpsThreshold' => [ 'description' => 'The traffic scrubbing threshold for the asset measured in Mbit/s. Unit: Mbit/s.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '300'."\n", ], 'DefensePpsThreshold' => [ 'description' => 'The traffic scrubbing threshold for the asset measured in packets per second (PPS). Unit: packets per second (pps).'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '70000', ], 'IsFullProtection' => [ 'description' => 'Indicates whether best-effort protection is enabled for the asset. Valid values:'."\n" ."\n" .'* **0**: Best-effort protection is disabled.'."\n" .'* **1**: Best-effort protection is enabled.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], ], ], ], ], 'description' => '', ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'NoAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for account. We recommend that you add a payment method.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C048E440-EA84-5E97-8C81-2A7060D0****_th**\\",\\n \\"Total\\": \\"1\\",\\n \\"RCInstanceList\\": [\\n {\\n \\"InstanceId\\": \\"rc-kti8hw44yy0x53******\\",\\n \\"InstanceType\\": \\"ecs\\",\\n \\"InstanceName\\": \\"rc-kti8hw44yy0x53******\\",\\n \\"InstanceStatus\\": \\"normal\\",\\n \\"IpAddressConfig\\": [\\n {\\n \\"InstanceIp\\": \\"39.105.XXX.XXX\\",\\n \\"IsBgppack\\": true,\\n \\"IpVersion\\": \\"v4\\",\\n \\"IpStatus\\": \\"normal\\",\\n \\"RegionId\\": \\"cn-beijing-wt97-a01\\",\\n \\"ElasticThreshold\\": 12310,\\n \\"BlackholeThreshold\\": 5200,\\n \\"DefenseBpsThreshold\\": 300,\\n \\"DefensePpsThreshold\\": 70000,\\n \\"IsFullProtection\\": 0\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', 'title' => 'DescribeRCInstanceIpAddress', 'description' => '### [](#)Supported database engine'."\n" ."\n" .'SQL Server'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'[Introduction to ApsaraDB RDS Custom](~~2864363~~)'."\n" ."\n" .'> If one or more assets of the current Alibaba Cloud account are added to an [Anti-DDoS Origin instance](~~63643~~), you can call the DescribeRCInstanceIpAddress operation to query the DDoS mitigation information and the details of the Anti-DDoS Origin instance. The information and the details include the basic protection threshold and traffic scrubbing threshold for the assets, DDoS mitigation status of the assets, ID of the instance, and the mitigation status of the instance.'."\n", ], 'DescribeRCInstanceDdosCount' => [ 'summary' => 'Queries the number of DDos attacks on an RDS Custom for SQL Server instance and monitors the security status of the instance in real time to assess potential security risks.', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the region in which the RDS Custom instance resides.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', ], ], [ 'name' => 'InstanceType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the asset that is assigned a public IP address. Fixed value: **ecs**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ecs', ], ], [ 'name' => 'DdosRegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the asset.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'docRequired' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'F77F3176-AAEA-5836-B2B4-A854E3ED****_Zv**', ], 'DdosCount' => [ 'description' => 'The number of instances that are under DDoS attacks.'."\n", 'type' => 'object', 'properties' => [ 'BlackholeCount' => [ 'description' => 'The number of instances for which blackhole filtering is triggered.'."\n", 'type' => 'string', 'example' => '0', ], 'InstacenCount' => [ 'description' => 'The total number of instances.'."\n", 'type' => 'string', 'example' => '6', ], 'DefenseCount' => [ 'description' => 'The number of instances for which traffic scrubbing is triggered.'."\n", 'type' => 'string', 'example' => '0', ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'NoAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for account. We recommend that you add a payment method.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F77F3176-AAEA-5836-B2B4-A854E3EF****_Zv**\\",\\n \\"DdosCount\\": {\\n \\"BlackholeCount\\": \\"0\\",\\n \\"InstacenCount\\": \\"6\\",\\n \\"DefenseCount\\": \\"0\\"\\n }\\n}","type":"json"}]', 'title' => 'DescribeRCInstanceDdosCount', 'description' => '### [](#)Supported database engine'."\n" ."\n" .'SQL Server'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'[Introduction to ApsaraDB RDS Custom](~~2864363~~)'."\n", ], 'StopRCInstance' => [ 'summary' => 'Stops an RDS Custom instance that is in the Running state. After the operation is successfully called, the status of the RDS Custom instance changes from Stopping to Stopped.', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'paid', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rc-m5sc1271fv344a1r****', ], ], [ 'name' => 'ForceStop', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to forcefully stop the instance. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false** (default)'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'StoppedMode', 'in' => 'query', 'schema' => [ 'type' => 'string', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '3E36DB6E-AE3B-53B6-A703-85F883FD1B2C', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'IncorrectInstanceStatus', 'errorMessage' => 'The current status of the resource does not support this operation.', ], [ 'errorCode' => 'IncorrectInstanceStatus.Initializing', 'errorMessage' => 'The specified instance status does not support this operation.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3E36DB6E-AE3B-53B6-A703-85F883FD1B2C\\"\\n}","type":"json"}]', 'title' => 'StopRCInstance', ], 'DeleteRCInstances' => [ 'summary' => 'Releases a subscription RDS Custom instance.', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'high', 'chargeType' => 'paid', ], 'parameters' => [ [ 'name' => 'Force', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to forcefully release a running instance. Valid values:'."\n" ."\n" .'* **Yes**'."\n" .'* **No** (default)'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'Yes', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The details of the instance.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rm-uf62br2491p5l****', ], 'required' => true, ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'TerminateSubscription', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to release an expired subscription instance. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false** (default)'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'DryRun', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to perform only a dry run, without performing the actual request. Valid values:'."\n" ."\n" .'* **true**: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, service limits, and insufficient inventory errors.'."\n" .'* **false** (default): performs a dry run and performs the actual request. If the request passes the dry run, the instance is created.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'E9DD55F4-1A5F-48CA-BA57-DFB3CA8C4C34', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'InstanceId is invalid, not found.', ], [ 'errorCode' => 'CallRdsCustomApi.Failure', 'errorMessage' => 'Failed to call rds custom api.', ], [ 'errorCode' => 'IncorrectInstanceStatus.Initializing', 'errorMessage' => 'The specified instance status does not support this operation.', ], [ 'errorCode' => 'IncorrectInstanceStatus', 'errorMessage' => 'The current status of the resource does not support this operation.', ], [ 'errorCode' => 'InvalidUserAccount.NotSupported', 'errorMessage' => 'the Specified user account Validated not supported.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'RemainRefundOrderFail', 'errorMessage' => 'Reamin refund order for instance fail.', ], [ 'errorCode' => 'InvalidOperation.DeletionProtection', 'errorMessage' => '%s.', ], [ 'errorCode' => 'InvalidOperation.NodeStatusNotSupported', 'errorMessage' => 'Please delete the pods on the vNode before deleting the vNode.', ], [ 'errorCode' => 'OperationDenied.TimeLimit', 'errorMessage' => 'The interval between the two conversion operations must be greater than 15 minutes.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The specified instance does not exist or is not supported.', ], [ 'errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'Specified instance does not exist or not support.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E9DD55F4-1A5F-48CA-BA57-DFB3CA8C4C34\\"\\n}","type":"json"}]', 'title' => 'DeleteRCInstances', 'description' => 'After an instance is released, all physical resources used by the instance are recycled. Relevant data is erased and cannot be restored.'."\n", ], 'RunRCInstances' => [ 'summary' => 'Creates one or more subscription RDS Custom instances. Before you call this operation, you must specify parameters such as ImageId, InstanceType, VSwitchId, and SecurityGroupId.', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'paid', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-beijing', ], ], [ 'name' => 'InstanceType', 'in' => 'query', 'schema' => [ 'description' => 'The instance type. For more information about the instance types that are supported by RDS Custom instances, see [Instance types for RDS Custom instances](~~2844823~~).'."\n", 'type' => 'string', 'required' => true, 'example' => 'mysql.i8.large.2cm', ], ], [ 'name' => 'Amount', 'in' => 'query', 'schema' => [ 'description' => 'The number of RDS Custom instances that you want to create. The parameter is available if you want to create multiple RDS Custom instances at a time.'."\n" ."\n" .'Valid values: **1** to **10**. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '1', 'default' => '1', ], ], [ 'name' => 'Period', 'in' => 'query', 'schema' => [ 'description' => 'The subscription duration of the instance. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1', ], ], [ 'name' => 'PeriodUnit', 'in' => 'query', 'schema' => [ 'description' => 'The unit of the subscription duration. Valid values:'."\n" ."\n" .'* **Year**'."\n" .'* **Month** (default)'."\n", 'type' => 'string', 'required' => false, 'example' => 'Year', 'default' => 'Month', 'enum' => [ 'Month', 'Year', ], ], ], [ 'name' => 'AutoRenew', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable auto-renewal for the instance. Valid values:'."\n" ."\n" .'* **true** (default)'."\n" .'* **false**'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'true', ], ], [ 'name' => 'SecurityEnhancementStrategy', 'in' => 'query', 'schema' => [ 'description' => 'The reserved parameter. This parameter is not supported.'."\n", 'type' => 'string', 'required' => false, 'example' => 'null', ], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCz****', ], ], [ 'name' => 'Password', 'in' => 'query', 'schema' => [ 'description' => 'The password of the account that is used to log on to the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => '2F9e9@a69c!e18b569c8', ], ], [ 'name' => 'VSwitchId', 'in' => 'query', 'schema' => [ 'description' => 'The vSwitch ID of the instance. You must specify this parameter when you create an instance of the virtual private cloud (VPC) type. The specified vSwitch and security group must belong to the same VPC.'."\n" ."\n" .'> If you specify the VSwitchId parameter, the zone specified by the ZoneId parameter must be the same as the zone in which the specified vSwitch resides. You can leave the ZoneId parameter empty. In this case, the system uses the zone in which the specified vSwitch resides.'."\n", 'type' => 'string', 'required' => true, 'example' => 'vsw-2vcd61ngm890sk****', ], ], [ 'name' => 'AutoUseCoupon', 'in' => 'query', 'schema' => [ 'type' => 'boolean', 'default' => 'true', ], ], [ 'name' => 'PromotionCode', 'in' => 'query', 'schema' => [ 'type' => 'string', ], ], [ 'name' => 'DataDisk', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The information about the data disks.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the data disk.'."\n", 'type' => 'object', 'properties' => [ 'Category' => [ 'description' => 'The type of the data disk. Set the value to **cloud_essd**, which indicates Enterprise SSDs (ESSDs).'."\n", 'type' => 'string', 'required' => false, 'example' => 'local_ssd', 'default' => 'cloud_essd', ], 'DeleteWithInstance' => [ 'description' => 'The reserved parameter. This parameter is not supported.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'null', ], 'Encrypted' => [ 'description' => 'Specifies whether to encrypt the cloud disk. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false** (default)'."\n", 'type' => 'string', 'required' => false, 'example' => 'false', ], 'PerformanceLevel' => [ 'description' => 'The reserved parameter. This parameter is not supported.'."\n", 'type' => 'string', 'required' => false, 'example' => 'null', ], 'Size' => [ 'description' => 'The size of the data disk. Unit: GiB.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], 'SnapshotId' => [ 'type' => 'string', ], 'Device' => [ 'type' => 'string', ], ], 'required' => false, ], 'required' => false, ], ], [ 'name' => 'InstanceName', 'in' => 'query', 'schema' => [ 'description' => 'The instance name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ceshi', ], ], [ 'name' => 'DeploymentSetId', 'in' => 'query', 'schema' => [ 'description' => 'The deployment set ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ds-uf6670sipmph5j5b6ke4', ], ], [ 'name' => 'InternetChargeType', 'in' => 'query', 'schema' => [ 'description' => 'The reserved parameter. This parameter is not supported.'."\n", 'type' => 'string', 'required' => false, 'example' => 'null', ], ], [ 'name' => 'InternetMaxBandwidthOut', 'in' => 'query', 'schema' => [ 'description' => 'The reserved parameter. This parameter is not supported.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => 'null', ], ], [ 'name' => 'SecurityGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the security group to which you want to add the new instance. Instances in the same security group can communicate with each other. The maximum number of instances allowed in a security group varies based on the type of the security group. For more information, see the "Security group limits" section in [Limits](~~25412~~).'."\n" ."\n" .'> The network type of the instance is determined by the security group specified by the SecurityGroupId parameter. For example, if the network type of the specified security group is VPC, the instance is a VPC-type instance. In this case, you must specify the VSwitchId parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'sg-uf6av412xaxixuezol6w', ], ], [ 'name' => 'ZoneId', 'in' => 'query', 'schema' => [ 'description' => 'The zone ID of the instance. You can call the DescribeZones operation to query the zone IDs.'."\n" ."\n" .'> If you specify the VSwitchId parameter, the zone specified by the ZoneId parameter must be the same as the zone in which the specified vSwitch resides. You can leave the ZoneId parameter empty. In this case, the system uses the zone in which the specified vSwitch resides.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-beijing-f', ], ], [ 'name' => 'IoOptimized', 'in' => 'query', 'schema' => [ 'description' => 'The reserved parameter. This parameter is not supported.'."\n", 'type' => 'string', 'required' => false, 'example' => 'null', ], ], [ 'name' => 'ImageId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the image used by the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'image-dsvjzw2ii8n4fvr6de', ], ], [ 'name' => 'SystemDisk', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The specification of the system disk.'."\n", 'type' => 'object', 'properties' => [ 'Category' => [ 'description' => 'The type of the system disk. Set the value to **cloud_essd**, which indicates ESSDs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cloud_essd', 'default' => 'cloud_essd', ], 'Size' => [ 'description' => 'The size of the system disk. Unit: GiB. Only performance level 1 (PL1) ESSDs are supported. Valid values: 20 to 2048.'."\n", 'type' => 'integer', 'required' => false, 'example' => '20', 'format' => 'int32', ], 'PerformanceLevel' => [ 'type' => 'string', ], ], 'required' => false, ], ], [ 'name' => 'InstanceChargeType', 'in' => 'query', 'schema' => [ 'description' => 'The billing method of the instance. Set the value to **Prepaid**, which indicates the subscription billing method.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Prepaid', ], ], [ 'name' => 'AutoPay', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable the automatic payment feature. Valid values:'."\n" ."\n" .'* **true** (default): enables the feature. Make sure that your account balance is sufficient.'."\n" .'* **false**: disables the feature. An unpaid order is generated.'."\n" ."\n" .'> If your account balance is insufficient, you can set the AutoPay parameter to false. In this case, an unpaid order is generated. You can complete the payment in the Expenses and Costs console.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'true', ], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => [ 'description' => 'The instance description. The description must be 2 to 256 characters in length and cannot start with http:// or https://.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Instance_Description', ], ], [ 'name' => 'KeyPairName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the AccessKey pair. You can specify only one name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'dell5502', ], ], [ 'name' => 'DryRun', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to perform only a dry run, without performing the actual request. Valid values:'."\n" ."\n" .'* **true**: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, service limits, and insufficient inventory errors.'."\n" .'* **false** (default): performs a dry run and performs the actual request. If the request passes the dry run, the instance is directly created.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Key' => [ 'type' => 'string', ], 'Value' => [ 'type' => 'string', ], ], ], 'maxItems' => 21, ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'type' => 'string', ], ], [ 'name' => 'CreateMode', 'in' => 'query', 'schema' => [ 'type' => 'string', ], ], [ 'name' => 'HostName', 'in' => 'query', 'schema' => [ 'type' => 'string', ], ], [ 'name' => 'SpotStrategy', 'in' => 'query', 'schema' => [ 'type' => 'string', ], ], [ 'name' => 'SupportCase', 'in' => 'query', 'schema' => [ 'type' => 'string', ], ], [ 'name' => 'CreateExtraParam', 'in' => 'query', 'schema' => [ 'type' => 'string', ], ], [ 'name' => 'CreateAckEdgeParam', 'in' => 'query', 'style' => 'json', 'schema' => [ 'type' => 'object', 'properties' => [ 'ClusterId' => [ 'type' => 'string', ], 'NodePoolId' => [ 'type' => 'string', ], ], ], ], [ 'name' => 'UserData', 'in' => 'query', 'schema' => [ 'type' => 'string', ], ], [ 'name' => 'UserDataInBase64', 'in' => 'query', 'schema' => [ 'type' => 'boolean', ], ], [ 'name' => 'DeletionProtection', 'in' => 'query', 'schema' => [ 'type' => 'boolean', ], ], [ 'name' => 'ScheduledRule', 'in' => 'query', 'schema' => [ 'title' => '分时弹性规则', 'type' => 'string', 'example' => '{"rule":[{"beginTime":"09:00","endTime":"17:00","acu":4}]}', ], ], [ 'name' => 'AcuType', 'in' => 'query', 'schema' => [ 'title' => 'acu类型', 'type' => 'string', 'example' => 'gn8is', ], ], [ 'name' => 'PasswordInherit', 'in' => 'query', 'schema' => [ 'title' => '是否使用镜像预设的密码。使用该参数时，Password 参数必须为空，同时您需要确保使用的镜像已经设置了密码。 默认false', 'type' => 'boolean', 'default' => 'false', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'InstanceIdSets' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'InstanceIdSet' => [ 'description' => 'The instance IDs (InstanceIdSet).'."\n", 'type' => 'array', 'items' => [ 'description' => 'The instance IDs (InstanceIdSet).'."\n", 'type' => 'string', 'example' => '{\'InstanceIdSet\': [\'rc-x0a263765axt7e****\']}', ], ], ], ], 'OrderId' => [ 'description' => 'The order ID.'."\n", 'type' => 'string', 'example' => '237850846720798', ], 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '535BD857-E88F-5B4F-A18C-FAF59A74741F', ], ], 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidUserAccount.NotSupported', 'errorMessage' => 'the Specified user account Validated not supported.', ], [ 'errorCode' => 'InvalidInstanceType.NotSupportDiskCategory', 'errorMessage' => 'The instanceType of the specified instance does not support this disk category.', ], [ 'errorCode' => 'InvalidInstanceType.ZoneNotSupported', 'errorMessage' => 'The specified zone does not support this instancetype.', ], [ 'errorCode' => 'InvalidInstanceType.NotSupported', 'errorMessage' => 'The specified instance type is not supported.', ], [ 'errorCode' => 'InvalidImageId.NotFound', 'errorMessage' => 'The specified ImageId does not exist.', ], [ 'errorCode' => 'InsufficientCapacity', 'errorMessage' => 'There is insufficient capacity available for the requested resource.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'InvalidPayType.NotSupported', 'errorMessage' => 'current instance pay type not support this operation.', ], [ 'errorCode' => 'InvalidTargetDBInstanceName.NotFound', 'errorMessage' => 'The specified DB instance name does not exist.', ], [ 'errorCode' => 'InvalidParameters.ImageId', 'errorMessage' => 'The specified image does not support the specified InstanceType.', ], [ 'errorCode' => 'InvalidDataDiskSize.ValueNotSupported', 'errorMessage' => 'The specified DataDisk.n.Size beyond the permitted range, or the capacity of snapshot exceeds the size limit of the specified disk category.', ], [ 'errorCode' => 'InvalidParameters.SystemSize', 'errorMessage' => 'SystemDisk size is invalid.', ], [ 'errorCode' => 'InvalidHostName.CustomMalformed', 'errorMessage' => 'Customized section of host name is invalid, please use valid format: [], [,], [m,], [,n], [m,n].', ], [ 'errorCode' => 'InvalidParameters.DataDisk', 'errorMessage' => 'the data disk size is less than dataDiskSnapshotsSize.', ], [ 'errorCode' => 'InvalidUserData.Base64FormatInvalid', 'errorMessage' => 'The specified UserData is not base64 encoded.', ], [ 'errorCode' => 'InvalidUserData.NotSupported', 'errorMessage' => 'The specified GPU instanceType is not supported the use of userdata.', ], [ 'errorCode' => 'InvalidParameter.TagValue', 'errorMessage' => 'The Tag.N.Value parameter is invalid.', ], [ 'errorCode' => 'NumberExceed.Tags', 'errorMessage' => 'The maximum number of Tags is exceeded. The maximum is 20.', ], [ 'errorCode' => 'Duplicate.TagKey', 'errorMessage' => 'The Tag.N.Key contains duplicate keys.', ], [ 'errorCode' => 'InvalidDescription.CustomMalformed', 'errorMessage' => 'Customized section of host description is invalid, please use valid format.', ], [ 'errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'InstanceId is invalid, not found.', ], [ 'errorCode' => 'InvalidParameters', 'errorMessage' => 'Invalid createMode or supportCase.', ], [ 'errorCode' => 'InvalidParam.DefaultVpcNotSupport', 'errorMessage' => 'Default vpc is not supported.', ], [ 'errorCode' => 'InvalidPerformanceLevel.Malformed', 'errorMessage' => 'The specified parameter DataDisk.n.PerformanceLevel is not valid.', ], [ 'errorCode' => 'InvalidSystemDiskCategory.ValueNotSupported', 'errorMessage' => 'The current operation does not support this system disk type.', ], [ 'errorCode' => 'InvalidParameter.DataDiskNotSupported', 'errorMessage' => 'DataDisk is not supported for vNode.', ], [ 'errorCode' => 'InvalidParameter', 'errorMessage' => 'Invalid parameter.', ], [ 'errorCode' => 'QuotaExceed.ElasticQuota', 'errorMessage' => '%s.', ], [ 'errorCode' => 'InvalidInstanceName.CustomMalformed', 'errorMessage' => 'The instance name is invalid, please use valid format.', ], [ 'errorCode' => 'InvalidParameter.ScheduledRule', 'errorMessage' => 'The specified parameter ScheduledRule is not valid.', ], [ 'errorCode' => 'InvalidParam.AcuType', 'errorMessage' => 'The parameter AcuType is invalid, please check and re-enter.', ], [ 'errorCode' => 'ResourceGroupId.InValid', 'errorMessage' => 'The Specified resource group id is not found.', ], [ 'errorCode' => 'InvalidDisk.CategoryFormat', 'errorMessage' => 'The specified eed category does not support this operation.', ], [ 'errorCode' => 'InvalidEEDDisk.NotSupport', 'errorMessage' => 'The specified eed category does not support this operation.', ], [ 'errorCode' => 'InvalidPrivateIpAddress.AlreadyUsed', 'errorMessage' => 'The specified IP is already used.', ], [ 'errorCode' => 'InvalidPrivateIpAddress.Mismatch', 'errorMessage' => 'Specified private IP address is not in the CIDR block of virtual switch.', ], [ 'errorCode' => 'InvalidSnapshot.Malformed', 'errorMessage' => 'The specified eed category does not support snapshot operation.', ], [ 'errorCode' => 'InvalidEEDDisk.DeleteWithInstanceConflict', 'errorMessage' => 'The specified disk is not a portable disk and cannot be set to DeleteWithInstance attribute false.', ], [ 'errorCode' => 'OperationDenied.InvalidClusterStatus', 'errorMessage' => 'The specified cluster status not support current operation.', ], [ 'errorCode' => 'InvalidParam.ClusterIdNotExist', 'errorMessage' => 'The specified cluster does not exist.', ], [ 'errorCode' => 'InvalidHostName.Malformed', 'errorMessage' => 'The specified parameter HostName is not valid.', ], ], 403 => [ [ 'errorCode' => 'InvalidSecurityGroupId.NotFound', 'errorMessage' => 'The specified SecurityGroupId does not found.', ], [ 'errorCode' => 'InvalidInstanceType.NotSupported', 'errorMessage' => 'The specified InstanceType is not Supported.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], [ 'errorCode' => 'QuotaExceed.DeploymentSetInstanceQuotaFull', 'errorMessage' => 'The instance quota in one deployment set exceeded.', ], [ 'errorCode' => 'InvalidDiskCategory.NotSupported', 'errorMessage' => 'The specified disk category is not support the specified instance type.', ], [ 'errorCode' => 'OperationDenied.InvalidCluster', 'errorMessage' => 'The operation is not allowed for the cluster, please check clusterId and createExtraParam.', ], [ 'errorCode' => 'InvalidParam.DataDisKSizeInvalid', 'errorMessage' => 'The specified cloud disk size is invalid.', ], [ 'errorCode' => 'InstanceDiskNumLimitExceed', 'errorMessage' => 'The number of specified disk in an instance exceeds.', ], [ 'errorCode' => 'OperationDenied.PerformanceLevelNotMatch', 'errorMessage' => 'The specified PerformanceLevel and disk size do not match.', ], [ 'errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'Arguments on this idempotent request are inconsistent with arguments used in previous request(s).', ], ], [ [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'The specified parameter is invalid.', ], [ 'errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], [ 'errorCode' => 'DeploymentSet.NotFound', 'errorMessage' => 'The specified deployment set does not exist.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], [ 'errorCode' => 'CallLxSdkFailed', 'errorMessage' => 'Error calling the order system, please try again later or contact service personnel.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"InstanceIdSets\\": {\\n \\"InstanceIdSet\\": [\\n \\"{\'InstanceIdSet\': [\'rc-x0a263765axt7e****\']}\\"\\n ]\\n },\\n \\"OrderId\\": \\"237850846720798\\",\\n \\"RequestId\\": \\"535BD857-E88F-5B4F-A18C-FAF59A74741F\\"\\n}","type":"json"}]', 'title' => 'RunRCInstances', 'description' => '* Before you create RDS Custom instances, you must submit a ticket to add your Alibaba Cloud account to a whitelist.'."\n" .'* You can create only subscription RDS Custom instances.'."\n" .'* Subscription RDS Custom instances are supported in the China (Shanghai), China (Shenzhen), China (Beijing), and China (Hangzhou) regions.'."\n", ], 'ModifyRCInstanceChargeType' => [ 'summary' => 'Modifies the billing method of an RDS Custom instance or cloud disks. You can call this operation to change the billing method of instances between pay-as-you-go and subscription.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', ], 'parameters' => [ [ 'name' => 'DryRun', 'in' => 'query', 'schema' => [ 'description' => 'The reserved parameter. This parameter is not supported.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'None', ], ], [ 'name' => 'InstanceIds', 'in' => 'query', 'schema' => [ 'description' => 'The reserved parameter. This parameter is not supported.'."\n", 'type' => 'string', 'required' => false, 'example' => 'None', ], ], [ 'name' => 'InstanceChargeType', 'in' => 'query', 'schema' => [ 'description' => 'The reserved parameter. This parameter is not supported.'."\n", 'type' => 'string', 'required' => false, 'enumValueTitles' => [], 'example' => 'None', 'enum' => [ 'PrePaid', 'PostPaid', ], ], ], [ 'name' => 'IncludeDataDisks', 'in' => 'query', 'schema' => [ 'description' => 'The reserved parameter. This parameter is not supported.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'None', ], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The custom client token that is used to ensure the idempotence of the request.'."\n" .'> The value can contain ASCII characters and can be up to 64 characters in length.', 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOC****', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the instance or disk.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rc-dh2jf9n6j4s14926****', ], ], [ 'name' => 'UsedTime', 'in' => 'query', 'schema' => [ 'description' => 'The subscription duration of the instance.'."\n" .'* If you set the **Period** parameter to **Year**, the value of the **UsedTime** parameter ranges from **1** to **5**.'."\n" .'* If the **Period** parameter is set to **Month**, the value of the **UsedTime** parameter ranges from **1** to **11**.'."\n" ."\n" .'> If you set the **PayType** parameter to **Prepaid**, you must specify this parameter.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'default' => '1', ], ], [ 'name' => 'AutoPay', 'in' => 'query', 'schema' => [ 'description' => 'The reserved parameter. This parameter is not supported.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'None', 'default' => 'true', 'title' => '是否自动支付。取值范围：'."\n" ."\n" .'true：自动支付。您需要确保账户余额充足，如果账户余额不足会生成异常订单，只能作废订单。'."\n" ."\n" .'false：只生成订单不扣费。'."\n" ."\n" .'默认值：true。', ], ], [ 'name' => 'PayType', 'in' => 'query', 'schema' => [ 'description' => 'The new billing method of the instance. Valid values:'."\n" .'* **Prepaid**: subscription.'."\n" .'* **Postpaid**: pay-as-you-go.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'Postpaid', 'title' => '变更后实例的付费类型，取值：'."\n" ."\n" .'Prepaid（PrePaid）：预付费（包年包月）'."\n" .'Postpaid（PostPaid）：后付费（按量付费）'."\n" .'默认值：PrePaid', 'default' => 'PrePaid', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => [ 'description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'Period', 'in' => 'query', 'schema' => [ 'description' => 'The renewal cycle of the instance. Valid values:'."\n" .'* **Year**'."\n" .'* **Month**'."\n" .'> This parameter must be specified if you set the PayType parameter to **Prepaid**.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'Month', 'enum' => [ 'Year', 'Month', 'Day', ], 'default' => 'Month', ], ], [ 'name' => 'BusinessInfo', 'in' => 'query', 'schema' => [ 'description' => 'The additional business information about the instance.', 'type' => 'string', 'required' => false, 'example' => 'None', ], ], [ 'name' => 'AutoRenew', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable the auto-renewal feature. Valid values:'."\n" .'* **true**'."\n" .'* **false**'."\n" .'> * This parameter is valid only when you change the billing method from pay-as-you-go to subscription.'."\n" .'> * All strings except **true** are considered **false**.', 'type' => 'string', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'AutoUseCoupon', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to use a coupon. Valid values:'."\n" .'* **true** (default)'."\n" .'* **false**', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true', ], ], [ 'name' => 'PromotionCode', 'in' => 'query', 'schema' => [ 'description' => 'The coupon code.', 'type' => 'string', 'required' => false, 'example' => '72802442****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'FeeOfInstances' => [ 'description' => 'The reserved parameter. This parameter is not supported.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The reserved parameter. This parameter is not supported.'."\n", 'type' => 'object', 'properties' => [ 'Currency' => [ 'description' => 'The reserved parameter. This parameter is not supported.'."\n", 'type' => 'string', 'example' => 'None', ], 'Fee' => [ 'description' => 'The reserved parameter. This parameter is not supported.'."\n", 'type' => 'string', 'example' => 'None', ], 'InstanceId' => [ 'description' => 'The reserved parameter. This parameter is not supported.'."\n", 'type' => 'string', 'example' => 'None', ], ], ], ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '6EF82B07-28D2-48D1-B5D6-7E78FED277C7', ], 'InstanceIds' => [ 'description' => 'The list of instance IDs.', 'type' => 'array', 'items' => [ 'description' => 'The instance IDs, including system disk IDs and data disk IDs.', 'type' => 'string', 'example' => '["rc-i2p26bde8bckf1419v11","rcd-c91jh0y9k9t2yn1j59hvo","rcd-i2p26bde8bckf1419v11"]', ], ], 'ExpiredTime' => [ 'description' => 'The time when the instance expires.'."\n" .'> If you change the billing method from subscription to pay-as-you-go, this parameter is not returned.', 'type' => 'array', 'items' => [ 'description' => 'The time when the instance expires.'."\n" .'> If you change the billing method from subscription to pay-as-you-go, this parameter is not returned.', 'type' => 'string', 'example' => '2024-06-28T00:00:00Z', ], ], 'ChargeType' => [ 'description' => 'The billing method.'."\n" .'* **POSTPAY**: pay-as-you-go.'."\n" .'* **PREPAY**: subscription.', 'type' => 'string', 'example' => 'POSTPAY', 'title' => '付费类型。'."\n" ."\n" .'Postpaid：按量付费'."\n" .'Prepaid：包年包月', ], 'OrderId' => [ 'description' => 'The order ID.'."\n", 'type' => 'string', 'example' => '2133400000****', ], ], 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The specified DB instance name does not exist.', ], [ 'errorCode' => 'InvalidInstanceUseType.NotSupport', 'errorMessage' => 'Specified instanceUseType does not support in RDS.', ], [ 'errorCode' => 'InvalidOrderCharge.NotSupport', 'errorMessage' => 'The specified order charge does not support in RDS.', ], [ 'errorCode' => 'InvalidOrderTask.NotSupport', 'errorMessage' => 'The Current InstanceId exist Order Task in RDS.', ], [ 'errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', ], [ 'errorCode' => 'IncompleteAccountInfo', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'IncompleteTaxInfo', 'errorMessage' => 'Your tax information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'InvalidPaymentMethod.Incomplete', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'InvalidPaymentMethod.Missing', 'errorMessage' => 'Your payment method is incomplete. We recommend that you add a payment method.', ], [ 'errorCode' => 'InsuffcientBalanceOrBankAccount', 'errorMessage' => 'Add a payment method or add funds to the prepayment balance. Get started by creating an instance.', ], [ 'errorCode' => 'OrderTaskAlreadyExists', 'errorMessage' => 'Order task already exists.', ], [ 'errorCode' => 'InvalidOldInstanceType.NotSupport', 'errorMessage' => 'Specified oldInstanceType does not support in RDS.', ], [ 'errorCode' => 'OperationDenied.TimeLimit', 'errorMessage' => 'The interval between the two conversion operations must be greater than 15 minutes.', ], [ 'errorCode' => 'InvalidResource.Format', 'errorMessage' => 'The specified parameter Resource is not valid.', ], [ 'errorCode' => 'InvalidPayType.Format', 'errorMessage' => 'The specified parameter PayType is not valid.', ], [ 'errorCode' => 'InvalidUsedTime.Format', 'errorMessage' => 'The specified parameter UsedTime is not valid.', ], [ 'errorCode' => 'InsufficientQuota.NoEnough', 'errorMessage' => 'Your current quota is insufficient. Please contact your channel partner to increase your quota.', ], [ 'errorCode' => 'SYSTEM.ILLEGALARGUMENT', 'errorMessage' => 'The current instance does not have a valid configuration when change the payType from Prepaid to Postpaid.', ], [ 'errorCode' => 'AccountMoneyValidate.error', 'errorMessage' => 'Insufficient funds available in the account.', ], [ 'errorCode' => 'ContainForbiddenLabel.error', 'errorMessage' => 'There is a label that prohibits placing an order, and the order cannot be placed.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'InvalidParam.PREPAY', 'errorMessage' => 'The prepaid instance purchase limit has been exceeded, and changing the payment method to prepaid is not allowed.', ], [ 'errorCode' => 'InvalidParam.POSTPAY', 'errorMessage' => 'It is not allowed to switch the payment method to postpaid after exceeding the purchase time limit for postpaid instances.', ], [ 'errorCode' => 'Order.InstHasUnsettledBills', 'errorMessage' => 'You currently have outstanding bills, please settle them first.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'InvalidChargeType.ValueNotSupported', 'errorMessage' => 'The deletion protection is only valid for postPaid instance, not for prePaid or spot instance.', ], [ 'errorCode' => 'InvalidParameter', 'errorMessage' => 'Invalid parameter.', ], [ 'errorCode' => 'InvalidRCInstanceID.NotFound', 'errorMessage' => 'The specified custom instanceID is not valid.', ], [ 'errorCode' => 'Invalid.UsedTimeFormat', 'errorMessage' => 'The specified UsedTime is not valid.', ], [ 'errorCode' => 'Invalid.PayTypeFormat', 'errorMessage' => 'The specified PayType is not valid.', ], [ 'errorCode' => 'Invalid.SpotStrategyFormat', 'errorMessage' => 'The specified SpotStrategy SpotAsPriceGo is not valid.', ], [ 'errorCode' => 'Invalid.PeriodAndUsedTimeFormat', 'errorMessage' => 'The specified Period and UsedTime is not valid.', ], [ 'errorCode' => 'Invalid.DiskFormat', 'errorMessage' => 'The specified disk is not attached to instance id.', ], [ 'errorCode' => 'InvalidPayType.NotSupported', 'errorMessage' => 'current instance pay type not support this operation.', ], [ 'errorCode' => 'InvalidDisk.SystemDiskFormat', 'errorMessage' => 'The specified system disk does not support this operation.', ], [ 'errorCode' => 'InvalidDisk.CategoryFormat', 'errorMessage' => 'The specified eed category does not support this operation.', ], [ 'errorCode' => 'InvalidEEDDisk.NotSupport', 'errorMessage' => 'The specified eed category does not support this operation.', ], ], 403 => [ [ 'errorCode' => 'OperationDenied.LockMode', 'errorMessage' => 'The operation is not permitted when the instance locked.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"FeeOfInstances\\": [\\n {\\n \\"Currency\\": \\"None\\",\\n \\"Fee\\": \\"None\\",\\n \\"InstanceId\\": \\"None\\"\\n }\\n ],\\n \\"RequestId\\": \\"6EF82B07-28D2-48D1-B5D6-7E78FED277C7\\",\\n \\"InstanceIds\\": [\\n \\"[\\\\\\"rc-i2p26bde8bckf1419v11\\\\\\",\\\\\\"rcd-c91jh0y9k9t2yn1j59hvo\\\\\\",\\\\\\"rcd-i2p26bde8bckf1419v11\\\\\\"]\\"\\n ],\\n \\"ExpiredTime\\": [\\n \\"2024-06-28T00:00:00Z\\"\\n ],\\n \\"ChargeType\\": \\"POSTPAY\\",\\n \\"OrderId\\": \\"2133400000****\\"\\n}","type":"json"}]', 'title' => 'ModifyRCInstanceChargeType', 'description' => '### [](#)Precautions'."\n" ."\n" .'* Before you call this operation, make sure that you are familiar with the subscription and pay-as-you-go billing methods and pricing of RDS Custom.'."\n" .'* The instances must be in the **Running** or **Stopped** state, and you have no overdue payments for the instances.'."\n" .'* The disk is in the **In_use** state and the billing method of the disk has not been changed within the previous 15 minutes.'."\n" .'* After you change the billing method, the payment is automatically completed. Make sure that the balance in your account is sufficient. Otherwise, your order becomes invalid and is canceled.'."\n" ."\n" .'### [](#)Considerations'."\n" ."\n" .'For more information, see the following documentation:'."\n" ."\n" .'* [Change the billing method of an instance](~~2878542~~)'."\n" .'* [Change the billing method of a disk](~~2878547~~)'."\n", ], 'StartRCInstance' => [ 'summary' => 'Starts RDS Custom instances that are in the Stopped state. After the operation is successfully called, the instances enter the Starting state.', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rc-l02u59b2kjfd2us0****', 'enum' => [], ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '8B993DA9-5272-5414-94E3-4CA8BA0146C2', ], ], 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8B993DA9-5272-5414-94E3-4CA8BA0146C2\\"\\n}","type":"json"}]', 'title' => 'StartRCInstance', ], 'DescribeRCInstanceAttribute' => [ 'summary' => 'Queries the details of an RDS Custom instance.', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rc-dh2jf9n6j4s14926****', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'PrivateIpAddress', 'in' => 'query', 'schema' => [ 'type' => 'string', ], ], [ 'name' => 'MaxDisksResults', 'in' => 'query', 'schema' => [ 'title' => '查看的实例挂载的磁盘数量,当不设置值时，默认值为：20，设置的值小于 10，默认值为 10', 'type' => 'integer', 'format' => 'int64', 'default' => '20', ], ], [ 'name' => 'InstanceName', 'in' => 'query', 'schema' => [ 'title' => '实例名称', 'type' => 'string', 'example' => 'k8s-node', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'ClusterId' => [ 'description' => 'The ID of the cluster to which the instance belongs.'."\n" ."\n" .'> This parameter will be deprecated. We recommend that you use other parameters to ensure compatibility.'."\n", 'type' => 'string', 'example' => 'None', ], 'Cpu' => [ 'description' => 'The number of CPU cores.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '4', ], 'CreationTime' => [ 'description' => 'The time when the instance was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2024-04-22T06:52:23Z', ], 'CreditSpecification' => [ 'description' => 'The performance mode of the burstable instance.'."\n", 'type' => 'string', 'example' => 'None', ], 'DataDisks' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'DataDisk' => [ 'description' => 'The details of the data disk.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details of the data disk.'."\n", 'type' => 'object', 'properties' => [ 'Category' => [ 'description' => 'The category of the data disk.'."\n", 'type' => 'string', 'example' => 'cloud_essd', ], 'Encrypted' => [ 'description' => 'Indicates whether the data disk is encrypted. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'string', 'example' => 'true', ], 'PerformanceLevel' => [ 'description' => 'The performance level of data disk. This parameter is available when the data disk is an Enterprise SSD (ESSD).'."\n", 'type' => 'string', 'example' => 'PL1', ], 'Size' => [ 'description' => 'The size of the data disk. Unit: GiB.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '40', ], 'DeleteWithInstance' => [ 'description' => 'Indicates whether the data disk is released when the instance is released. Valid values:'."\n" ."\n" .'* **true**: The data disk is released when the instance is released.'."\n" .'* **false**: The data disk is reserved when the instance is released.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Device' => [ 'title' => '磁盘挂载的实例的设备名', 'type' => 'string', 'example' => '/dev/xvdb', ], 'SnapshotId' => [ 'title' => '创建云盘使用的快照 ID。'."\n" .'如果创建云盘时，没有指定快照，则该参数值为空。', 'type' => 'string', 'example' => 'rcds-bp18um4r4f2fve24**', ], ], ], ], ], ], 'DedicatedHostAttribute' => [ 'description' => 'The attributes of the dedicated hosts.'."\n", 'type' => 'object', 'properties' => [ 'DedicatedHostId' => [ 'description' => 'The ID of the dedicated host.'."\n", 'type' => 'string', 'example' => 'None', ], 'DedicatedHostName' => [ 'description' => 'The name of the dedicated host.'."\n", 'type' => 'string', 'example' => 'None', ], ], ], 'Tags' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Tag' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ResourceId' => [ 'type' => 'string', ], 'TagKey' => [ 'type' => 'string', ], 'ResourceType' => [ 'type' => 'string', ], 'TagValue' => [ 'type' => 'string', ], ], ], ], ], ], 'DeploymentSetId' => [ 'description' => 'The ID of the deployment set.'."\n", 'type' => 'string', 'example' => 'ds-uf6c8qerk019bj1l****', ], 'Description' => [ 'description' => 'The instance description.'."\n", 'type' => 'string', 'example' => 'test', ], 'DiskType' => [ 'description' => 'The reserved parameter.'."\n", 'type' => 'string', 'example' => 'None', ], 'EcsInstanceType' => [ 'description' => 'The Elastic Compute Service (ECS) instance family.'."\n", 'type' => 'string', 'example' => 'ecs.g6.2xlarge', ], 'EipAddress' => [ 'description' => 'The elastic IP address (EIP) associated with the instance.'."\n", 'type' => 'object', 'properties' => [ 'AllocationId' => [ 'description' => 'The EIP ID.'."\n", 'type' => 'string', 'example' => 'eip-bp14k3rz6cbg6zxbe****', ], 'Bandwidth' => [ 'description' => 'The maximum Internet bandwidth of the EIP. Unit: Mbit/s.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'InternetChargeType' => [ 'description' => 'The billing method of the Internet-facing instance. Valid values:'."\n" ."\n" .'* **paybytraffic:** pay-by-data-transfer'."\n" .'* **paybybandwidth**: pay-by-bandwidth'."\n" ."\n" .'> If the **pay-by-traffic** billing method is used for network usage, the maximum inbound and outbound bandwidths are used as the upper limits of bandwidths instead of guaranteed performance specifications. In scenarios in which demands exceed resource supplies, the maximum bandwidths may not be reached. If you want guaranteed bandwidths for your instance, use the **pay-by-bandwidth** billing method for network usage.'."\n", 'type' => 'string', 'example' => 'paybytraffic', ], 'IpAddress' => [ 'description' => 'The EIP.'."\n", 'type' => 'string', 'example' => '8.147.XXX.XXX', ], ], ], 'EnableJumboFrame' => [ 'description' => 'Indicates whether the Jumbo Frame feature is enabled for the instance. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'false', ], 'ExpiredTime' => [ 'description' => 'The expiration time. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2024-08-10T00:00:00Z', ], 'HostName' => [ 'description' => 'The instance hostname.'."\n", 'type' => 'string', 'example' => 'iZ2zej1n3cin51rlmby****', ], 'HostType' => [ 'description' => 'The storage type of the host. Valid values:'."\n" ."\n" .'* **dhg_cloud_ssd**: ESSD'."\n" .'* **dhg_local_ssd**: local SSD'."\n", 'type' => 'string', 'example' => 'dhg_cloud_ssd', ], 'ImageId' => [ 'description' => 'The image ID of the instance.'."\n", 'type' => 'string', 'example' => 'm-2oqiu973jwcxe****', ], 'InnerIpAddress' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'IpAddress' => [ 'description' => 'The private IP addresses of the instance in the classic network.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The private IP address of the instance in the classic network.'."\n", 'type' => 'string', 'example' => 'None', ], ], ], ], 'InstanceId' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rc-dh2jf9n6j4s14926****', ], 'InstanceName' => [ 'description' => 'The instance name.'."\n", 'type' => 'string', 'example' => 'test', ], 'InstanceNetworkType' => [ 'description' => 'The network type. Valid values:'."\n" ."\n" .'* **classic**'."\n" .'* **vpc**'."\n", 'type' => 'string', 'example' => 'vpc', ], 'InstanceType' => [ 'description' => 'The instance type of the instance.'."\n", 'type' => 'string', 'example' => 'mysql.x4.xlarge.6cm', ], 'InternetChargeType' => [ 'description' => 'The billing method for network usage. Valid values:'."\n" ."\n" .'* **PayByBandwidth**: pay-by-bandwidth'."\n" .'* **PayByTraffic**: pay-by-data-transfer'."\n" ."\n" .'> If the **pay-by-traffic** billing method is used for network usage, the maximum inbound and outbound bandwidths are used as the upper limits of bandwidths instead of guaranteed performance specifications. In scenarios in which demands exceed resource supplies, the maximum bandwidths may not be reached. If you want guaranteed bandwidths for your instance, use the **pay-by-bandwidth** billing method for network usage.'."\n", 'type' => 'string', 'example' => 'PayByTraffic', ], 'InternetMaxBandwidthIn' => [ 'description' => 'The maximum inbound bandwidth from the Internet. Unit: Mbit/s.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'InternetMaxBandwidthOut' => [ 'description' => 'The maximum outbound bandwidth to the Internet. Unit: Mbit/s.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'IoOptimized' => [ 'description' => 'Indicates whether the instance is I/O optimized.'."\n" ."\n" .'* **optimized**: The instance is I/O optimized.'."\n" .'* **none**: The instance is not I/O optimized.'."\n", 'type' => 'string', 'example' => 'optimized', ], 'KeyPairName' => [ 'description' => 'The name of the key pair.'."\n", 'type' => 'string', 'example' => 'test_01', ], 'Memory' => [ 'description' => 'The memory capacity of the instance. Unit: MiB.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '8192', ], 'OperationLocks' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'LockReason' => [ 'description' => 'The reasons why the instance is locked.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The reason why the instance is locked.'."\n", 'type' => 'object', 'properties' => [ 'LockReason' => [ 'description' => 'The reason why the instance is locked. Valid values:'."\n" ."\n" .'* **financial**: The instance is locked due to overdue payments.'."\n" .'* **security**: The instance is locked for security purposes.'."\n" .'* **recycling**: The instance is locked because the instance is a preemptible instance and pending to be released.'."\n" .'* **dedicatedhostfinancial**: The instance is locked due to overdue payments for the dedicated host.'."\n" .'* **refunded**: The instance is locked because a refund was made for the instance.'."\n", 'type' => 'string', 'example' => 'None', ], ], ], ], ], ], 'PublicIpAddress' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'IpAddress' => [ 'description' => 'The public IP address of the instance.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The public IP address of the instance.'."\n", 'type' => 'string', 'example' => 'None', ], ], ], ], 'RegionId' => [ 'description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'EA2D4F34-01A7-46EB-A339-D80882135206', ], 'SecurityGroupIds' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'SecurityGroupId' => [ 'description' => 'The security groups.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The security group ID.'."\n", 'type' => 'string', 'example' => 'sg-m5e7xkprgt1pi1cw****', ], ], ], ], 'SerialNumber' => [ 'description' => 'The serial number of the instance.'."\n", 'type' => 'string', 'example' => 'b076f6ff-46d1-4234-a608-4e951ed6****', ], 'Status' => [ 'description' => 'The instance status. Valid values:'."\n" ."\n" .'* **Pending**'."\n" .'* **Running**'."\n" .'* **Starting**'."\n" .'* **Stopping**'."\n" .'* **Stopped**'."\n", 'type' => 'string', 'example' => 'Running', ], 'StoppedMode' => [ 'description' => 'Indicates whether the billing of the instance continues after the instance is stopped. Valid values:'."\n" ."\n" .'* **KeepCharging**: The billing of the instance continues after the instance is stopped, and resources are retained for the instance.'."\n" .'* **StopCharging**: The billing of the instance stops after the instance is stopped. After the instance is stopped, resources such as CPU cores, memory resources, and public IP address are released. The instance may be unable to restart if some required resources are out of stock in the current region.'."\n" .'* **Not-applicable**: The No Fees for Stopped Instances feature is not supported for the instance.'."\n", 'type' => 'string', 'example' => 'Not-applicable', ], 'VlanId' => [ 'description' => 'The virtual LAN (VLAN) ID of the instance.'."\n" ."\n" .'> This parameter will be deprecated. We recommend that you use other parameters to ensure compatibility.'."\n", 'type' => 'string', 'example' => 'None', ], 'VpcAttributes' => [ 'description' => 'The virtual private cloud (VPC) attributes of the instance.'."\n", 'type' => 'object', 'properties' => [ 'NatIpAddress' => [ 'description' => 'The network address translation (NAT) IP address of the instance. The NAT IP address is used by instances in different VPCs for communication.'."\n", 'type' => 'string', 'example' => 'None', ], 'PrivateIpAddress' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'IpAddress' => [ 'description' => 'The private IP addresses of the instance.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The private IP address of the instance.'."\n", 'type' => 'string', 'example' => '192.168.XXX.XXX', ], ], ], ], 'VSwitchId' => [ 'description' => 'The vSwitch ID.'."\n", 'type' => 'string', 'example' => 'vsw-bp1nt15muovrc5qdj****', ], 'VpcId' => [ 'description' => 'The VPC ID.'."\n", 'type' => 'string', 'example' => 'vpc-2zeu747v4765aw2id****', ], ], ], 'ZoneId' => [ 'description' => 'The zone ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou-b', ], 'ResourceGroupId' => [ 'type' => 'string', ], 'InstanceChargeType' => [ 'type' => 'string', ], 'DbType' => [ 'type' => 'string', ], 'SpotStrategy' => [ 'type' => 'string', ], 'SystemDisk' => [ 'type' => 'object', 'properties' => [ 'SystemDiskSize' => [ 'type' => 'integer', 'format' => 'int64', ], 'SystemDiskCategory' => [ 'type' => 'string', ], 'SystemDiskPerformanceLevel' => [ 'type' => 'string', ], 'DeleteWithInstance' => [ 'type' => 'boolean', ], 'Encrypted' => [ 'type' => 'string', ], ], ], 'CreateMode' => [ 'type' => 'integer', 'format' => 'int32', ], 'AutoRenew' => [ 'type' => 'boolean', ], 'DeletionProtection' => [ 'type' => 'boolean', ], 'Gpu' => [ 'type' => 'integer', 'format' => 'int32', ], 'GpuTypes' => [ 'type' => 'string', ], 'NodeType' => [ 'type' => 'string', ], 'UserData' => [ 'title' => '用户自定义数据', 'type' => 'string', ], ], 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'InvalidInstanceName.CustomMalformed', 'errorMessage' => 'The instance name is invalid, please use valid format.', ], [ 'errorCode' => 'InvalidDBInstanceName.MultipleFound', 'errorMessage' => 'The specified DB instance name matches multiple instances.', ], [ 'errorCode' => 'InvalidRCInstanceID.NotFound', 'errorMessage' => 'The specified custom instanceID is not valid.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'The parameter is invalid.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ClusterId\\": \\"None\\",\\n \\"Cpu\\": 4,\\n \\"CreationTime\\": \\"2024-04-22T06:52:23Z\\",\\n \\"CreditSpecification\\": \\"None\\",\\n \\"DataDisks\\": {\\n \\"DataDisk\\": [\\n {\\n \\"Category\\": \\"cloud_essd\\",\\n \\"Encrypted\\": \\"true\\",\\n \\"PerformanceLevel\\": \\"PL1\\",\\n \\"Size\\": 40,\\n \\"DeleteWithInstance\\": true,\\n \\"Device\\": \\"/dev/xvdb\\",\\n \\"SnapshotId\\": \\"rcds-bp18um4r4f2fve24**\\"\\n }\\n ]\\n },\\n \\"DedicatedHostAttribute\\": {\\n \\"DedicatedHostId\\": \\"None\\",\\n \\"DedicatedHostName\\": \\"None\\"\\n },\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"ResourceId\\": \\"rc-e8sh6w29j5l4jgjp****\\",\\n \\"TagKey\\": \\"testRC\\",\\n \\"ResourceType\\": \\"ALIYUN::RDS::CUSTOM\\",\\n \\"TagValue\\": \\"test01\\"\\n }\\n ]\\n },\\n \\"DeploymentSetId\\": \\"ds-uf6c8qerk019bj1l****\\",\\n \\"Description\\": \\"test\\",\\n \\"DiskType\\": \\"None\\",\\n \\"EcsInstanceType\\": \\"ecs.g6.2xlarge\\",\\n \\"EipAddress\\": {\\n \\"AllocationId\\": \\"eip-bp14k3rz6cbg6zxbe****\\",\\n \\"Bandwidth\\": 5,\\n \\"InternetChargeType\\": \\"paybytraffic\\",\\n \\"IpAddress\\": \\"8.147.XXX.XXX\\"\\n },\\n \\"EnableJumboFrame\\": false,\\n \\"ExpiredTime\\": \\"2024-08-10T00:00:00Z\\",\\n \\"HostName\\": \\"iZ2zej1n3cin51rlmby****\\",\\n \\"HostType\\": \\"dhg_cloud_ssd\\",\\n \\"ImageId\\": \\"m-2oqiu973jwcxe****\\",\\n \\"InnerIpAddress\\": {\\n \\"IpAddress\\": [\\n \\"None\\"\\n ]\\n },\\n \\"InstanceId\\": \\"rc-dh2jf9n6j4s14926****\\",\\n \\"InstanceName\\": \\"test\\",\\n \\"InstanceNetworkType\\": \\"vpc\\",\\n \\"InstanceType\\": \\"mysql.x4.xlarge.6cm\\",\\n \\"InternetChargeType\\": \\"PayByTraffic\\",\\n \\"InternetMaxBandwidthIn\\": 1,\\n \\"InternetMaxBandwidthOut\\": 5,\\n \\"IoOptimized\\": \\"optimized\\",\\n \\"KeyPairName\\": \\"test_01\\",\\n \\"Memory\\": 8192,\\n \\"OperationLocks\\": {\\n \\"LockReason\\": [\\n {\\n \\"LockReason\\": \\"None\\"\\n }\\n ]\\n },\\n \\"PublicIpAddress\\": {\\n \\"IpAddress\\": [\\n \\"None\\"\\n ]\\n },\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"RequestId\\": \\"EA2D4F34-01A7-46EB-A339-D80882135206\\",\\n \\"SecurityGroupIds\\": {\\n \\"SecurityGroupId\\": [\\n \\"sg-m5e7xkprgt1pi1cw****\\"\\n ]\\n },\\n \\"SerialNumber\\": \\"b076f6ff-46d1-4234-a608-4e951ed6****\\",\\n \\"Status\\": \\"Running\\",\\n \\"StoppedMode\\": \\"Not-applicable\\",\\n \\"VlanId\\": \\"None\\",\\n \\"VpcAttributes\\": {\\n \\"NatIpAddress\\": \\"None\\",\\n \\"PrivateIpAddress\\": {\\n \\"IpAddress\\": [\\n \\"192.168.XXX.XXX\\"\\n ]\\n },\\n \\"VSwitchId\\": \\"vsw-bp1nt15muovrc5qdj****\\",\\n \\"VpcId\\": \\"vpc-2zeu747v4765aw2id****\\"\\n },\\n \\"ZoneId\\": \\"cn-hangzhou-b\\",\\n \\"ResourceGroupId\\": \\"rg-aeky6z354ks****\\",\\n \\"InstanceChargeType\\": \\"PostPaid\\",\\n \\"DbType\\": \\"mysql\\",\\n \\"SpotStrategy\\": \\"NoSpot\\",\\n \\"SystemDisk\\": {\\n \\"SystemDiskSize\\": 40,\\n \\"SystemDiskCategory\\": \\"cloud_essd\\",\\n \\"SystemDiskPerformanceLevel\\": \\"PL1\\",\\n \\"DeleteWithInstance\\": true,\\n \\"Encrypted\\": \\"false\\"\\n },\\n \\"CreateMode\\": 0,\\n \\"AutoRenew\\": false,\\n \\"DeletionProtection\\": false,\\n \\"Gpu\\": 2,\\n \\"GpuTypes\\": \\"NVIDIA V100\\",\\n \\"NodeType\\": \\"rds_vnode\\",\\n \\"UserData\\": \\"IyEvYmluL3NoCmVjaG8gXCJIZWxsbyBXb3JsZC4gVGhlIHRpbWUgaXMgbm93ICQoZGF0ZSAtUikhXCIgfCB0ZWUgL3Jvb3QvdXNlcmRhdGFfdGVzdDA2MjB0d28udHh0\\"\\n}","type":"json"}]', 'title' => 'DescribeRCInstanceAttribute', ], 'ResizeRCInstanceDisk' => [ 'summary' => 'Expand the storage capacity of an RDS Custom instance.', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'paid', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'docRequired' => false, ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rm-uf62br2491p5l****', ], ], [ 'name' => 'AutoPay', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable the automatic payment feature for the instance. Valid values:'."\n" ."\n" .'* **true** (default): enables the feature. Make sure that your account balance is sufficient.'."\n" .'* **false**: disables the feature. An unpaid order is generated.'."\n" ."\n" .'> If your account balance is insufficient, you can set AutoPay to false. In this case, an unpaid order is generated. You can complete the payment in the Expenses and Costs console.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'DryRun', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to perform only a dry run, without performing the actual request. Valid values:'."\n" ."\n" .'* **true**: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, service limits, and insufficient inventory errors.'."\n" .'* **false**: performs a dry run and performs the actual request. If the request passes the dry run, the instance is created.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'The method that you want to use to resize the disk. Valid values:'."\n" ."\n" .'* **offline** (default): resizes disks offline. After you resize a disk offline, you must restart the instance for the resizing operation to take effect.'."\n" .'* **online**: resizes disks online. After you resize a disk online, the resizing operation takes effect immediately and you do not need to restart the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'online', ], ], [ 'name' => 'NewSize', 'in' => 'query', 'schema' => [ 'description' => 'The new disk size. Unit: GiB.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100', 'docRequired' => true, ], ], [ 'name' => 'DiskId', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, 'docRequired' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'OrderId' => [ 'description' => 'The order ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '230546833080102', ], 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'CallEcsApi.Failure', 'errorMessage' => 'Fail to call ECS API.', ], [ 'errorCode' => 'InvalidOrderTask.NotSupport', 'errorMessage' => 'The Current InstanceId exist Order Task in RDS.', ], [ 'errorCode' => 'InvalidUserAccount.NotSupported', 'errorMessage' => 'the Specified user account Validated not supported.', ], [ 'errorCode' => 'InvalidStorageSize.Direction', 'errorMessage' => 'The specified parameter StorageSize does not meet the updating direction constraint requirements.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'Invalid DBInstanceId NotFound.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OrderId\\": 230546833080102,\\n \\"RequestId\\": \\"1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC\\"\\n}","type":"json"}]', 'title' => 'ResizeRCInstanceDisk', ], 'ModifyRCInstance' => [ 'summary' => 'Upgrades or downgrades the instance type of a subscription RDS Custom instance. The new instance type takes effect for the remaining lifecycle of the instance.', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'paid', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hagnzhou', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rm-uf62br2491p5l****', ], ], [ 'name' => 'InstanceType', 'in' => 'query', 'schema' => [ 'description' => 'The new instance type. For more information about the instance types that are supported by RDS Custom instances, see [Instance types of RDS Custom instances](~~2844823~~).'."\n", 'type' => 'string', 'required' => false, 'example' => 'mysql.i8.large.2cm'."\n", ], ], [ 'name' => 'Direction', 'in' => 'query', 'schema' => [ 'description' => 'The type of the change that you want to perform on the instance. Valid values:'."\n" ."\n" .'> This parameter is optional. The system can automatically determine whether the instance change is an upgrade or a downgrade. If you want to specify this parameter, take note of the following items:'."\n" ."\n" .'* **Upgrade** (default): upgrades the instance type. Make sure that your account balance is sufficient.'."\n" .'* **Down**: downgrades the instance type. If the new instance type specified by InstanceType has lower specifications than the current instance type, set Direction to Down.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Up', 'enum' => [ 'Up', 'Down', ], ], ], [ 'name' => 'AutoPay', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable the automatic payment feature. Valid values:'."\n" ."\n" .'* **true** (default): enables the feature. You must make sure that your account balance is sufficient.'."\n" .'* **false**: disables the feature. An unpaid order is generated.'."\n" ."\n" .'> If your account balance is insufficient, you can set AutoPay to false. In this case, an unpaid order is generated. You can complete the payment in the Expenses and Costs console.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true', ], ], [ 'name' => 'DryRun', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to perform only a dry run, without performing the actual request. Valid values:'."\n" ."\n" .'* **true**: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, service limits, and resource inventory.'."\n" .'* **false**: performs a dry run and performs the actual request. If the request passes the dry run, the operation is performed.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'RebootWhenFinished', 'in' => 'query', 'schema' => [ 'type' => 'boolean', 'default' => 'true', ], ], [ 'name' => 'RebootTime', 'in' => 'query', 'schema' => [ 'type' => 'string', ], ], [ 'name' => 'AutoUseCoupon', 'in' => 'query', 'schema' => [ 'type' => 'boolean', 'default' => 'true', ], ], [ 'name' => 'PromotionCode', 'in' => 'query', 'schema' => [ 'type' => 'string', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'OrderId' => [ 'description' => 'The order ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '100789370230206', ], 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '6EF82B07-28D2-48D1-B5D6-7E78FED277C7', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'CallEcsApi.Failure', 'errorMessage' => 'Fail to call ECS API.', ], [ 'errorCode' => 'InvalidOrderTask.NotSupport', 'errorMessage' => 'The Current InstanceId exist Order Task in RDS.', ], [ 'errorCode' => 'InvalidInstanceType.ValueNotSupported', 'errorMessage' => 'The specified InstanceType does not exist or beyond the permitted range.', ], [ 'errorCode' => 'InvalidInstanceStatus.NotStopped', 'errorMessage' => 'The specified Instance status is not stopped.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'DependencyViolation.InstanceType', 'errorMessage' => 'The current InstanceType cannot be changed to the specified InstanceType.', ], ], 403 => [ [ 'errorCode' => 'OperationDenied', 'errorMessage' => 'The requested instance is out of resources.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], [ 'errorCode' => 'UnexpectedSwitchTime', 'errorMessage' => 'SwitchTime should not be null when switch at timePoint mode', ], ], [ [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'Invalid DBInstanceId NotFound.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'InvalidUserAccount.NotSupported', 'errorMessage' => 'the Specified user account Validated not supported.', ], [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OrderId\\": 100789370230206,\\n \\"RequestId\\": \\"6EF82B07-28D2-48D1-B5D6-7E78FED277C7\\"\\n}","type":"json"}]', 'title' => 'ModifyRCInstance', 'description' => 'Before you call this operation, make sure that you are familiar with the billing methods, pricing, and refund rules of RDS Custom.'."\n" ."\n" .'Before you call this operation, take note of the following items:'."\n" ."\n" .'* You cannot change the instance type of an expired instance. You can renew the instance and try again.'."\n" ."\n" .'* When you downgrade the instance type of an instance, take note of the following items:'."\n" ."\n" .' * The instance must be in the Stopped state.'."\n" .' * The price difference is refunded to the payment account you used. Vouchers that have been redeemed are not refundable.'."\n" ."\n" .'* The operation is asynchronous. Wait 5 to 10 seconds for the instance type change to complete. Then, restart the instance by calling the RebootInstance operation or by using the console for the instance type change to take effect. If you restart only the operating system of the instance, the instance type change does not take effect. If the instance is in the Stopped state, you need only to start the instance. You do not need to restart the instance after it enters the Running state.'."\n", ], 'DeleteRCDeploymentSet' => [ 'summary' => 'Deletes a deployment set for an RDS Custom instance. Before you call this operation, you must specify parameters such as RegionId and DeploymentSetId.', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', ], 'parameters' => [ [ 'name' => 'DeploymentSetId', 'in' => 'query', 'schema' => [ 'description' => 'The deployment set ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ds-uf6c8qerk019bj1l****', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '8B993DA9-5272-5414-94E3-4CA8BA0146C2', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'DependencyViolation.NotEmpty', 'errorMessage' => 'There are still instance(s) in the specified DeploymentSetId.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8B993DA9-5272-5414-94E3-4CA8BA0146C2\\"\\n}","type":"json"}]', 'title' => 'DeleteRCDeploymentSet', ], 'DescribeRCMetricList' => [ 'summary' => 'Queries the monitoring data of a metric for an RDS Custom instance.', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'MetricName', 'in' => 'query', 'schema' => [ 'description' => 'The metric that you want to use. For more information, see [CloudMonitor metrics](https://cms.console.aliyun.com/metric-meta/acs_ecs_dashboard/ecs).', 'type' => 'string', 'required' => true, 'example' => 'CPUUtilization', ], ], [ 'name' => 'Express', 'in' => 'query', 'schema' => [ 'description' => 'The reserved parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'None', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => 'The end of the time range to query. The end time must be later than the start time. Example: `2024-08-06 10:15:00`.'."\n", 'type' => 'string', 'required' => false, 'example' => '2024-08-06 10:15:00', ], ], [ 'name' => 'NextToken', 'in' => 'query', 'schema' => [ 'description' => 'The pagination token.'."\n", 'type' => 'string', 'required' => false, 'example' => '6178f1825f9fb76ce0b5e8707e68181f', ], ], [ 'name' => 'Length', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page.'."\n" ."\n" .'Default value: 1000.'."\n" ."\n" .'> The maximum value of the Length parameter in a request is 1440.'."\n", 'type' => 'string', 'required' => false, 'example' => '1000', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => 'The beginning of the time range to query. Example: `2024-08-06 10:05:00`.'."\n", 'type' => 'string', 'required' => false, 'example' => '2024-08-06 10:05:00', ], ], [ 'name' => 'Period', 'in' => 'query', 'schema' => [ 'description' => 'The statistical period of the monitoring data.'."\n" ."\n" .'Set the value to 60 or an integer multiple of 60.'."\n" ."\n" .'Unit: seconds.'."\n" ."\n" .'Default value: 60.'."\n", 'type' => 'string', 'required' => false, 'example' => '60', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rc-dh2jf9n6j4s14926****', ], ], [ 'name' => 'Dimensions', 'in' => 'query', 'schema' => [ 'type' => 'string', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'Code' => [ 'description' => 'The HTTP status code returned.'."\n", 'type' => 'string', 'example' => '200', ], 'Datapoints' => [ 'description' => 'The monitoring data.'."\n", 'type' => 'string', 'example' => '[{\\"timestamp\\":1722909960000,\\"instanceId\\":\\"rc-dh2jf9n6j4s14926****\\",\\"userId\\":\\"1695619988087373\\",\\"Minimum\\":0.097,\\"Maximum\\":0.097,\\"Average\\":0.097},{\\"timestamp\\":1722910020000,\\"instanceId\\":\\"rc-dh2jf9n6j4s14926****\\",\\"userId\\":\\"1695619988087373\\",\\"Minimum\\":0.093,\\"Maximum\\":0.093,\\"Average\\":0.093}]', ], 'Message' => [ 'description' => 'The message that is returned for the request.'."\n" ."\n" .'> If the request is successful, **Successful** is returned. If the request fails, an error message that contains information such as an error code is returned.'."\n", 'type' => 'string', 'example' => 'successful', ], 'NextToken' => [ 'description' => 'The pagination token.'."\n", 'type' => 'string', 'example' => '6178f1825f9fb76ce0b5e8707e68181f', ], 'Period' => [ 'description' => 'The statistical period of the monitoring data.'."\n", 'type' => 'string', 'example' => '60', ], 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'EA2D4F34-01A7-46EB-A339-D80882135206', ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Datapoints\\": \\"[{\\\\\\\\\\\\\\"timestamp\\\\\\\\\\\\\\":1722909960000,\\\\\\\\\\\\\\"instanceId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"rc-dh2jf9n6j4s14926****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"userId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1695619988******\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Minimum\\\\\\\\\\\\\\":0.097,\\\\\\\\\\\\\\"Maximum\\\\\\\\\\\\\\":0.097,\\\\\\\\\\\\\\"Average\\\\\\\\\\\\\\":0.097},{\\\\\\\\\\\\\\"timestamp\\\\\\\\\\\\\\":1722910020000,\\\\\\\\\\\\\\"instanceId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"rc-dh2jf9n6j4s14926****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"userId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1695619988******\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Minimum\\\\\\\\\\\\\\":0.093,\\\\\\\\\\\\\\"Maximum\\\\\\\\\\\\\\":0.093,\\\\\\\\\\\\\\"Average\\\\\\\\\\\\\\":0.093}]\\",\\n \\"Message\\": \\"successful\\",\\n \\"NextToken\\": \\"6178f1825f9fb76ce0b5e8707e******\\",\\n \\"Period\\": \\"60\\",\\n \\"RequestId\\": \\"EA2D4F34-01A7-46EB-A339-D80882135206\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'DescribeRCMetricList', ], 'DescribeRCInstances' => [ 'summary' => 'Queries the details of an RDS Custom instance.', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'VpcId', 'in' => 'query', 'schema' => [ 'description' => 'The virtual private cloud (VPC) ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vpc-uf6f7l4fg90****', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page.'."\n" ."\n" .'Maximum value: 100.'."\n" ."\n" .'Default value: 10.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => 'The page number.'."\n" ."\n" .'Page starts from page 1.'."\n" ."\n" .'Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'docRequired' => true, ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rm-2ze704f*****'."\n", ], ], [ 'name' => 'Tag', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => [ 'type' => 'string', ], ], [ 'name' => 'PublicIp', 'in' => 'query', 'schema' => [ 'type' => 'string', ], ], [ 'name' => 'HostIp', 'in' => 'query', 'schema' => [ 'type' => 'string', ], ], [ 'name' => 'InstanceIds', 'in' => 'query', 'schema' => [ 'type' => 'string', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'type' => 'string', ], ], [ 'name' => 'InstanceName', 'in' => 'query', 'schema' => [ 'title' => '实例名称', 'type' => 'string', 'example' => 'k8s-node', ], ], [ 'name' => 'ImageId', 'in' => 'query', 'schema' => [ 'type' => 'string', ], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => [ 'type' => 'string', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'E9DD55F4-1A5F-48CA-BA57-DFB3CA8C4C34', ], 'PageNumber' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'RCInstances' => [ 'description' => 'The details of the instance.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'HostIp' => [ 'description' => 'The host IP address.'."\n", 'type' => 'string', 'example' => '172.30.XXX.XXX', ], 'HostName' => [ 'description' => 'The host name.'."\n", 'type' => 'string', 'example' => 'i-2zeaiz4g9u23f40m****', ], 'ClusterName' => [ 'description' => 'The cluster name.'."\n", 'type' => 'string', 'example' => 'testrdscustom', ], 'DbType' => [ 'description' => 'The database type.'."\n", 'type' => 'string', 'example' => 'rds_custom', ], 'Status' => [ 'description' => 'The instance status. Valid values:'."\n" ."\n" .'* **Pending**'."\n" .'* **Running**'."\n" .'* **Starting**'."\n" .'* **Stopping**'."\n" .'* **Stopped**'."\n" ."\n" .'> If the value returned for the DescribeRCInstances operation is different from the value that is returned for the **DescribeRCInstanceAttribute** operation, the value returned for the **DescribeRCInstanceAttribute** operation shall prevail.'."\n", 'type' => 'string', 'example' => 'Running', ], 'RegionId' => [ 'description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], 'VpcId' => [ 'description' => 'The VPC ID.'."\n", 'type' => 'string', 'example' => 'vpc-uf6f7l4fg90****'."\n", ], 'InstanceId' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-2ze704f*****'."\n", ], 'Description' => [ 'description' => 'The instance description.'."\n", 'type' => 'string', 'example' => 'test', ], 'GmtCreated' => [ 'description' => 'The time when the task was created. The time is displayed in GMT.'."\n", 'type' => 'string', 'example' => '2023-03-22 07:56:53.0', ], 'InstanceChargeType' => [ 'type' => 'string', ], 'CreateMode' => [ 'type' => 'string', ], 'ZoneId' => [ 'type' => 'string', ], 'TagResources' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ResourceId' => [ 'type' => 'string', ], 'ResourceType' => [ 'type' => 'string', ], 'TagKey' => [ 'type' => 'string', ], 'TagValue' => [ 'type' => 'string', ], ], ], ], 'SpotStrategy' => [ 'type' => 'string', ], 'Tags' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ResourceId' => [ 'type' => 'string', ], 'ResourceType' => [ 'type' => 'string', ], 'TagKey' => [ 'type' => 'string', ], 'TagValue' => [ 'type' => 'string', ], ], ], ], 'PublicIp' => [ 'type' => 'string', ], 'InstanceType' => [ 'type' => 'string', ], 'InstanceTypeFamily' => [ 'type' => 'string', ], 'SecurityGroupId' => [ 'type' => 'string', ], 'Cpu' => [ 'type' => 'integer', 'format' => 'int32', ], 'Memory' => [ 'type' => 'integer', 'format' => 'int32', ], 'ExpiredTime' => [ 'type' => 'string', ], 'DeploymentSetId' => [ 'type' => 'string', ], 'ImageId' => [ 'type' => 'string', ], 'VpcAttributes' => [ 'type' => 'object', 'properties' => [ 'NatIpAddress' => [ 'type' => 'string', ], 'PrivateIpAddress' => [ 'type' => 'array', 'items' => [ 'type' => 'string', ], ], 'VSwitchId' => [ 'type' => 'string', ], 'VpcId' => [ 'type' => 'string', ], ], ], 'NodeType' => [ 'type' => 'string', ], 'InstanceName' => [ 'title' => '实例名称', 'type' => 'string', 'example' => 'k8s-node', ], 'StoppedMode' => [ 'type' => 'string', ], 'OSName' => [ 'title' => '实例的操作系统名称。', 'type' => 'string', 'example' => 'CentOS 7.4 64 位', ], 'OSType' => [ 'title' => '实例的操作系统类型，分为 Windows Server 和 Linux 两种。可能值：'."\n" ."\n" .'windows。'."\n" .'linux。'."\n", 'type' => 'string', 'example' => 'linux', ], 'StartTime' => [ 'title' => '实例最近一次的启动时间。以 ISO 8601 为标准，并使用 UTC+0 时间，格式为 yyyy-MM-ddTHH:mmZ。', 'type' => 'string', 'example' => '2017-12-10T04:04Z', ], 'EcsHostName' => [ 'title' => '实例主机名。', 'type' => 'string', 'example' => 'testHostName', ], ], 'description' => '', ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'InvalidParameter.InstanceIds', 'errorMessage' => 'The specified parameter InstanceIds is invalid.', ], [ 'errorCode' => 'InvalidDBInstanceName.MultipleFound', 'errorMessage' => 'The specified DB instance name matches multiple instances.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'The specified parameter is invalid.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The specified instance does not exist or is not supported.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E9DD55F4-1A5F-48CA-BA57-DFB3CA8C4C34\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 2,\\n \\"RCInstances\\": [\\n {\\n \\"HostIp\\": \\"172.16.XX.XX\\",\\n \\"HostName\\": \\"i-2zeaiz4g9u23f40m****\\",\\n \\"ClusterName\\": \\"testrdscustom\\",\\n \\"DbType\\": \\"rds_custom\\",\\n \\"Status\\": \\"Running\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"VpcId\\": \\"vpc-uf6f7l4fg90****\\\\n\\",\\n \\"InstanceId\\": \\"rm-2ze704f*****\\\\n\\",\\n \\"Description\\": \\"test\\",\\n \\"GmtCreated\\": \\"2023-03-22 07:56:53.0\\",\\n \\"InstanceChargeType\\": \\"PrePaid\\",\\n \\"CreateMode\\": \\"0\\",\\n \\"ZoneId\\": \\"cn-hangzhou-j\\",\\n \\"TagResources\\": [\\n {\\n \\"ResourceId\\": \\"rc-t8q22a87745hf8******\\",\\n \\"ResourceType\\": \\"ALIYUN::RDS::CUSTOM\\",\\n \\"TagKey\\": \\"testRC\\",\\n \\"TagValue\\": \\"test01\\"\\n }\\n ],\\n \\"SpotStrategy\\": \\"NoSpot\\",\\n \\"Tags\\": [\\n {\\n \\"ResourceId\\": \\"rc-t8q22a87745hf8******\\",\\n \\"ResourceType\\": \\"ALIYUN::RDS::CUSTOM\\",\\n \\"TagKey\\": \\"testRC\\",\\n \\"TagValue\\": \\"test01\\"\\n }\\n ],\\n \\"PublicIp\\": \\"121.89.XX.XX\\\\n\\",\\n \\"InstanceType\\": \\"mysql.x2.xlarge.6cm\\",\\n \\"InstanceTypeFamily\\": \\"x.6cm\\",\\n \\"SecurityGroupId\\": \\"sg-2vcbcivwfxiozhtp****\\",\\n \\"Cpu\\": 8,\\n \\"Memory\\": 16384,\\n \\"ExpiredTime\\": \\"2025-05-02T16:00:00Z\\",\\n \\"DeploymentSetId\\": \\"ds-bp14k1xvolvsy4z3****\\",\\n \\"ImageId\\": \\"aliyun_3_x64_20G_alibase_20250117.vhd\\",\\n \\"VpcAttributes\\": {\\n \\"NatIpAddress\\": \\"None\\",\\n \\"PrivateIpAddress\\": [\\n \\"172.16.XX.XX\\"\\n ],\\n \\"VSwitchId\\": \\"vsw-bp1nb3pv03878tgnj****\\",\\n \\"VpcId\\": \\"vpc-uf6f7l4fg90****\\"\\n },\\n \\"NodeType\\": \\"rds_vnode\\",\\n \\"InstanceName\\": \\"k8s-node\\",\\n \\"StoppedMode\\": \\"\\",\\n \\"OSName\\": \\"CentOS 7.4 64 位\\",\\n \\"OSType\\": \\"linux\\",\\n \\"StartTime\\": \\"2017-12-10T04:04Z\\",\\n \\"EcsHostName\\": \\"testHostName\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => 'DescribeRCInstances', ], 'DescribeRCImageList' => [ 'summary' => 'Queries custom images that can be used to create an RDS Custom instance. Before you call this operation, you must specify parameters such as RegionId.', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'maximum' => '50', ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'The image type. Set the value to **self**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'self', 'default' => 'self', ], ], [ 'name' => 'Architecture', 'in' => 'query', 'schema' => [ 'description' => 'The image architecture. Valid values:'."\n" ."\n" .'* x86\\_64'."\n" .'* arm64'."\n", 'type' => 'string', 'required' => false, 'example' => 'x86_64', ], ], [ 'name' => 'ImageId', 'in' => 'query', 'schema' => [ 'type' => 'string', ], ], [ 'name' => 'ImageName', 'in' => 'query', 'schema' => [ 'type' => 'string', ], ], [ 'name' => 'InstanceType', 'in' => 'query', 'schema' => [ 'type' => 'string', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '2553A660-E4EB-4AF4-A402-8AFF70A49143', ], 'TotalCount' => [ 'description' => 'The total number of images.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'PageNumber' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'RegionId' => [ 'description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], 'Images' => [ 'description' => 'The information about the images.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The image information.'."\n", 'type' => 'object', 'properties' => [ 'Architecture' => [ 'description' => 'The image architecture. Valid values:'."\n" ."\n" .'* x86\\_64'."\n" .'* arm64'."\n", 'type' => 'string', 'example' => 'x86_64', ], 'CreationTime' => [ 'description' => 'The time when the image was created.'."\n", 'type' => 'string', 'example' => '2024-04-25T02:17:40Z', ], 'Description' => [ 'description' => 'The description of the image.'."\n", 'type' => 'string', 'example' => 'test', ], 'ImageId' => [ 'description' => 'The image ID.'."\n", 'type' => 'string', 'example' => 'm-2oqiu973jwcxe****', ], 'ImageName' => [ 'description' => 'The image name.'."\n", 'type' => 'string', 'example' => 'Created_from_i-2zeh17y17sz677x****', ], 'ImageVersion' => [ 'description' => 'The image version.'."\n", 'type' => 'string', 'example' => '2', ], 'IsPublic' => [ 'description' => 'Indicates whether the image is a public image. Public images include public images provided by Alibaba Cloud and custom images published as community images.'."\n" ."\n" .'* **true**: The image is a public image.'."\n" .'* **false**: The image is not a public image.'."\n", 'type' => 'boolean', 'example' => 'false', ], 'OSName' => [ 'description' => 'The display name of the operating system in Chinese.'."\n", 'type' => 'string', 'example' => '', ], 'OSNameEn' => [ 'description' => 'The display name of the operating system in English.'."\n", 'type' => 'string', 'example' => 'Alibaba Cloud Linux 2.1903 LTS 64 bit Quick Boot', ], 'OSType' => [ 'description' => 'The type of the operating system. Valid values:'."\n" ."\n" .'* **windows**'."\n" .'* **linux**'."\n", 'type' => 'string', 'example' => 'linux', ], 'Size' => [ 'description' => 'The image size. Unit: GiB.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '40', ], 'Status' => [ 'description' => 'The image status. Valid values:'."\n" ."\n" .'* **Unavailable**'."\n" .'* **Available**'."\n" .'* **Creating**'."\n" .'* **CreateFailed**'."\n", 'type' => 'string', 'example' => 'Available', ], 'Usage' => [ 'description' => 'Indicates whether the image is used by the RDS Custom instance. Valid values:'."\n" ."\n" .'* **instance**: The image is used to create one or more RDS Custom instances.'."\n" .'* **none**: The image is not used to create RDS Custom instances.'."\n", 'type' => 'string', 'example' => 'instance', ], 'IsSupportRdsCustom' => [ 'type' => 'boolean', ], 'Platform' => [ 'type' => 'string', ], 'DiskDeviceMappings' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Type' => [ 'type' => 'string', ], 'Device' => [ 'type' => 'string', ], 'Size' => [ 'type' => 'string', ], ], ], ], ], ], ], ], 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2553A660-E4EB-4AF4-A402-8AFF70A49143\\",\\n \\"TotalCount\\": 2,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 5,\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Images\\": [\\n {\\n \\"Architecture\\": \\"x86_64\\",\\n \\"CreationTime\\": \\"2024-04-25T02:17:40Z\\",\\n \\"Description\\": \\"test\\",\\n \\"ImageId\\": \\"m-2oqiu973jwcxe****\\",\\n \\"ImageName\\": \\"Created_from_i-2zeh17y17sz677x****\\",\\n \\"ImageVersion\\": \\"2\\",\\n \\"IsPublic\\": false,\\n \\"OSName\\": \\"Alibaba Cloud Linux 2.1903 LTS 64位 快速启动版\\",\\n \\"OSNameEn\\": \\"Alibaba Cloud Linux 2.1903 LTS 64 bit Quick Boot\\",\\n \\"OSType\\": \\"linux\\",\\n \\"Size\\": 40,\\n \\"Status\\": \\"Available\\",\\n \\"Usage\\": \\"instance\\",\\n \\"IsSupportRdsCustom\\": true,\\n \\"Platform\\": \\"Aliyun\\",\\n \\"DiskDeviceMappings\\": [\\n {\\n \\"Type\\": \\"system\\",\\n \\"Device\\": \\"/dev/xvdb\\",\\n \\"Size\\": \\"40\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', 'title' => 'DescribeRCImageList', ], 'ModifyRCInstanceDescription' => [ 'summary' => 'Modifies the name of an RDS Custom instance.', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rc-m5ei7b1w38w2l91x****', ], ], [ 'name' => 'InstanceDescription', 'in' => 'query', 'schema' => [ 'description' => 'The instance name.'."\n" ."\n" .'> The name must be 2 to 255 characters in length and can contain letters, digits, `underscores (_)`, and `hyphens (-)`. It must start with a letter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testInstance', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'CCECD3CD-AB2D-4F6D-BEDE-47BC90A398D2', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CCECD3CD-AB2D-4F6D-BEDE-47BC90A398D2\\"\\n}","type":"json"}]', 'title' => 'ModifyRCInstanceDescription', ], 'CreateRCDisk' => [ 'summary' => 'Creates a data disk for an RDS Custom instance.', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'high', 'chargeType' => 'paid', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'SnapshotId', 'in' => 'query', 'schema' => [ 'description' => 'The snapshot that you want to use to create the disk.'."\n" ."\n" .'* The snapshots of RDS Custom instances and the non-shared snapshots of ECS instances are supported.'."\n" .'* If the size of the snapshot specified by **SnapshotId** is greater than the value of **Size**, the size of the created disk is equal to the specified snapshot size. If the snapshot size is less than the **Size** value, the size of the created disk is equal to the **Size** value.'."\n" .'* You cannot create elastic ephemeral disks from snapshots.'."\n" .'* Snapshots that were created on or before July 15, 2013 cannot be used to create disks.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rcds-umtnkvevqbu****', ], ], [ 'name' => 'Size', 'in' => 'query', 'schema' => [ 'description' => 'The disk size. Unit: GiB. This parameter is required. Valid values:'."\n" ."\n" .'* Valid values if you set DiskCategory to **cloud_efficiency**: 20 to 32768.'."\n" ."\n" .'* Valid values if you set DiskCategory to **cloud_ssd**: 20 to 32768.'."\n" ."\n" .'* Valid values if you set DiskCategory to **cloud_auto**: 1 to 65536.'."\n" ."\n" .'* Valid values when DiskCategory is set to cloud_essd: depending on the value of **PerformanceLevel**.****'."\n" ."\n" .' * Valid values if PerformanceLevel is set to PL0: 1 to 65536'."\n" .' * Valid values if PerformanceLevel is set to PL1: 20 to 65536'."\n" .' * Valid values if PerformanceLevel is set to PL2: 461 to 65536'."\n" .' * Valid values if PerformanceLevel is set to PL3: 1261 to 65536'."\n" ."\n" .'If **SnapshotId** is specified and the size of the corresponding snapshot is greater than the **Size** value, the size of the created disk is the same as that of the snapshot. If the snapshot size is less than the **Size** value, the size of the created disk is equal to the **Size** value.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2000', ], ], [ 'name' => 'DiskCategory', 'in' => 'query', 'schema' => [ 'description' => 'The data disk type. Valid values:'."\n" ."\n" .'* **cloud_efficiency**: ultra disk.'."\n" .'* **cloud_ssd**: standard SSD'."\n" .'* **cloud_essd**: ESSD'."\n" .'* **cloud_auto** (default): Premium ESSD'."\n", 'type' => 'string', 'required' => false, 'example' => 'cloud_ssd', 'default' => 'cloud_auto', ], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => [ 'description' => 'The disk description. The description must be 2 to 256 characters in length and cannot start with `http://` or `https://`.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', ], ], [ 'name' => 'PerformanceLevel', 'in' => 'query', 'schema' => [ 'description' => 'The performance level (PL) of ESSDs. Valid values:'."\n" ."\n" .'* **PL0**: A single ESSD delivers up to 10,000 random read/write IOPS.'."\n" .'* **PL1: An ESSD delivers up to 50,000 random read/write IOPS.**'."\n" .'* **PL2**: A single ESSD delivers up to 100,000 random read/write IOPS.'."\n" .'* **PL3**: A single ESSD delivers up to 1,000,000 random read/write IOPS.'."\n" ."\n" .'For information about ESSD PLs, see [ESSDs](~~2859916~~).'."\n", 'type' => 'string', 'required' => false, 'example' => 'PL1', ], ], [ 'name' => 'ZoneId', 'in' => 'query', 'schema' => [ 'description' => 'The zone ID.'."\n" ."\n" .'This parameter is required if you do not specify **InstanceId**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-a', ], ], [ 'name' => 'InstanceChargeType', 'in' => 'query', 'schema' => [ 'description' => 'The billing method. Valid values:'."\n" ."\n" .'* **Postpaid**: pay-as-you-go Pay-as-you-go disks do not require to be attached. You can also attach the pay-as-you-go disk to an instance of any billing method based on your business requirements.'."\n" .'* **Prepaid**: subscription Subscription disks must be attached to a subscription instance. Set **InstanceId** to the ID of a subscription instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Postpaid', 'default' => 'Postpaid', ], ], [ 'name' => 'PeriodUnit', 'in' => 'query', 'schema' => [ 'description' => 'A reserved parameter. You do not need to specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'none', ], ], [ 'name' => 'Period', 'in' => 'query', 'schema' => [ 'description' => 'A reserved parameter. You do not need to specify this parameter.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => 'none', ], ], [ 'name' => 'AutoRenew', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable auto-renewal. You must specify this parameter only when the data disk uses the subscription billing method. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n" ."\n" .'> The auto-renewal cycle is one month for a monthly subscription. The auto-renewal cycle is one year for a yearly subscription.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'AutoPay', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable automatic payment. Valid values:'."\n" ."\n" .'* **true** (default): enables automatic payment. Make sure that your account balance is sufficient.'."\n" .'* **false**: does not automatically complete the payment. An unpaid order is generated.'."\n" ."\n" .'> If your account balance is insufficient, you can set the parameter to false. In this case, an unpaid order is generated. You can complete the payment in the Expenses and Costs console.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'DiskName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the data disk. The name must be 2 to 128 characters in length and can contain letters and digits. The name can contain colons (:), underscores (\\_), periods (.), and hyphens (-).'."\n", 'type' => 'string', 'required' => false, 'example' => 'ZStack-Hybrid-Test-ECS-Instance', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the instance to which you want to attach the disk. If you set **InstanceChargeType** to **Prepaid**, you must set InstanceId to the ID of a subscription instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rc-v28c6k3jupp61m2t****', ], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The list of tags.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The tags.'."\n", 'type' => 'object', 'properties' => [ 'Key' => [ 'description' => 'The tag key. You can create N tag keys at a time. Valid values of N: **1 to 20**. The tag key cannot be an empty string.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testkey1', ], 'Value' => [ 'description' => 'The tag value. You can query N values at a time. Valid values of N: **1** to **20**. The tag value can be an empty string.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testvalue1', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 21, ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-ac****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'DiskId' => [ 'description' => 'The cloud disk ID.'."\n", 'type' => 'string', 'example' => 'rcd-2zegrjtnkp6dqbe1egca', ], 'OrderId' => [ 'description' => 'The order ID.'."\n", 'type' => 'string', 'example' => '100789370230206', ], 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'F2911788-25E8-42E5-A3A3-1B38D263F01E', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'InvalidUserAccount.NotSupported', 'errorMessage' => 'the Specified user account Validated not supported.', ], [ 'errorCode' => 'InvalidPayType.NotSupported', 'errorMessage' => 'current instance pay type not support this operation.', ], [ 'errorCode' => 'InvalidSnapshotIds.Malformed', 'errorMessage' => 'The specified snapshotId is not valid.', ], [ 'errorCode' => 'InvalidParameter.InstanceChargeType', 'errorMessage' => 'Please input a PREPAY instanceId when creating a PREPAY disk.', ], [ 'errorCode' => 'InvalidDataDiskCategory.NotSupported', 'errorMessage' => 'Specified disk category is not supported.', ], [ 'errorCode' => 'InvalidDescription.Malformed', 'errorMessage' => 'The specified parameter "Description" is not valid.', ], [ 'errorCode' => 'InvalidDiskCategory.ValueNotSupported', 'errorMessage' => 'Specified disk category is not supported.', ], [ 'errorCode' => 'InvalidDiskSize.NotSupported', 'errorMessage' => 'The specified parameter size is not valid.', ], [ 'errorCode' => 'InvalidZoneId.DiskCategoryUnsupported', 'errorMessage' => 'The specified disk category does not support setting the ZoneId.', ], [ 'errorCode' => 'InvalidInstanceType.NotSupportDiskCategory', 'errorMessage' => 'The instanceType of the specified instance does not support this disk category.', ], [ 'errorCode' => 'InvalidSnapshot.Malformed', 'errorMessage' => 'The specified eed category does not support snapshot operation.', ], [ 'errorCode' => 'Invalid.RCInstanceExpired', 'errorMessage' => 'The requested custom instance has expired.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], [ 'errorCode' => 'InvalidOperation.DataDiskNotSupport', 'errorMessage' => 'Specified instance does not support the data disk category or size.', ], [ 'errorCode' => 'InvalidParam.DataDisKSizeInvalid', 'errorMessage' => 'The specified cloud disk size is invalid.', ], [ 'errorCode' => 'OperationDenied.SnapshotNotSupport', 'errorMessage' => 'The specified snapshot type is shared, which is not supported.', ], [ 'errorCode' => 'OperationDenied.SnapshotNotAvailable', 'errorMessage' => 'The specified snapshot is not available.', ], [ 'errorCode' => 'DiskCategory.OperationNotSupported', 'errorMessage' => 'The type of the specified disk does not support creating a snapshot.', ], [ 'errorCode' => 'InvalidDiskCategory.NotSupported', 'errorMessage' => 'The specified disk category is not support the specified instance type.', ], [ 'errorCode' => 'InvalidOperation.InstanceTypeNotSupport', 'errorMessage' => 'The instance type of the specified instance does not support hot detach disk.', ], [ 'errorCode' => 'OperationDenied.InstanceDiskLimitExceeded', 'errorMessage' => 'The amount of the disk on instance in question reach its limits.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], [ 'errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The target availability zone does not have sufficient resources.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DiskId\\": \\"rcd-2zegrjtnkp6dqbe1****\\",\\n \\"OrderId\\": \\"100789370230206\\",\\n \\"RequestId\\": \\"F2911788-25E8-42E5-A3A3-1B38D263F01E\\"\\n}","type":"json"}]', 'title' => 'CreateRCDisk', 'description' => '* The disk can be an ultra disk, an Enterprise SSD (ESSD), an SSD, or a Premium ESSD. By default, Premium ESSD is used.'."\n" .'* When you set InstanceChargeType to **Prepaid**, the disk billing method is subscription. You must set **InstanceId** to the ID of a subscription instance. The expiration time of the disk must be the same as that of the instance to which the disk is attached.'."\n" .'* When you set **InstanceChargeType** to Postpaid, the disk billing method is pay-as-you-go. You do not need to attach the disk to an instance. You can also attach the pay-as-you-go disk to an instance of any billing method based on your business requirements.'."\n" .'* The type and number of disks that can be attached to an instance vary based on instance specifications.'."\n", ], 'ReplaceRCInstanceSystemDisk' => [ 'summary' => 'Reinstalls the operating system (OS) of an RDS Custom instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', ], ], [ 'name' => 'ImageId', 'in' => 'query', 'schema' => [ 'description' => 'The image ID that is used when you reinstall the OS.'."\n", 'type' => 'string', 'required' => false, 'example' => 'm-2zec4lvlhcdkyd13****', 'docRequired' => true, ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rc-m5ei7b1w38w2l91x****', 'docRequired' => true, ], ], [ 'name' => 'Password', 'in' => 'query', 'schema' => [ 'description' => 'The new logon password of the RDS Custom instance. If you do not specify this parameter, you must reset the logon password after the OS is reinstalled.'."\n" ."\n" .'* The value must be 8 to 30 characters in length.'."\n" .'* The value must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. Supported special characters include: ( ) \\` ~ ! @ # $ % ^ & \\* - \\_ + ='."\n", 'type' => 'string', 'required' => false, 'example' => 'testPassword', ], ], [ 'name' => 'KeyPairName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the new key pair. If you do not specify this parameter, you must reset the key pair after the OS is reinstalled.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testKeyPairName', ], ], [ 'name' => 'IsLocalDisk', 'in' => 'query', 'schema' => [ 'description' => 'The reserved parameter. This parameter is not supported.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'None', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '8B993DA9-5272-5414-94E3-4CA8BA0146C2', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'Abs.ImageNotFound', 'errorMessage' => 'The specified Image is disabled or is deleted.', ], [ 'errorCode' => 'InvalidParameters.ImageId', 'errorMessage' => 'The specified image does not support the specified InstanceType.', ], [ 'errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'Specified parameter is not valid', ], [ 'errorCode' => 'OperationDenied', 'errorMessage' => 'The specified image contains the snapshot of the data disk,does not support this operation.', ], [ 'errorCode' => 'IncorrectInstanceStatus', 'errorMessage' => 'The current status of the resource does not support this operation.', ], [ 'errorCode' => 'IncorrectInstanceStatus.Initializing', 'errorMessage' => 'The specified instance status does not support this operation.', ], [ 'errorCode' => 'InvalidImageId.NotFound', 'errorMessage' => 'The specified ImageId does not exist.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'NoAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for account. We recommend that you add a payment method.', ], [ 'errorCode' => 'InvalidHostStatus.Format', 'errorMessage' => 'Specified host status is not valid.', ], [ 'errorCode' => 'ReplaceSystemDisk.InvalidImageId', 'errorMessage' => 'The paid image only replace instance systemDisk using the original image.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstance', 'errorMessage' => 'The current DB instance does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], [ 'errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance does not exist or is not supported.', ], [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8B993DA9-5272-5414-94E3-4CA8BA0146C2\\"\\n}","type":"json"}]', 'title' => 'ReplaceRCInstanceSystemDisk', 'description' => '* The instance must be in the Stopped state.'."\n" .'* If you reinstall the system, the data on the original system disk is lost. Exercise caution when you perform this operation.'."\n", ], 'DescribeRCInstanceVncUrl' => [ 'summary' => 'Queries the Virtual Network Computing (VNC) logon address of an RDS Custom instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-chengdu', 'docRequired' => true, ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rc-e6e3757b8px27oa5****', 'docRequired' => true, ], ], [ 'name' => 'DbType', 'in' => 'query', 'schema' => [ 'description' => 'The database engine. Valid values:'."\n" ."\n" .'* **mssql**: SQL Server'."\n" .'* **mysql**: MySQL'."\n", 'type' => 'string', 'required' => false, 'example' => 'mysql', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'F2911788-25E8-42E5-A3A3-1B38D263F01E', ], 'LoginUrl' => [ 'description' => 'The VNC logon address.'."\n" ."\n" .'> The address returned is valid only for 15 seconds. If you do not use the returned address to establish a connection within 15 seconds, the address expires and you must call the operation again to obtain a new address.'."\n", 'type' => 'string', 'example' => 'https://g.alicdn.com/aliyun/ecs-console-vnc2/0.0.8/index.html?vncUrl=****&instanceId=i-2vcb1qjj8z5dl8iw****&isWindows=false', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'NoAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for account. We recommend that you add a payment method.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2911788-25E8-42E5-A3A3-1B38D263F01E\\",\\n \\"LoginUrl\\": \\"https://g.alicdn.com/aliyun/ecs-console-vnc2/0.0.8/index.html?vncUrl=****&instanceId=i-2vcb1qjj8z5dl8iw****&isWindows=false\\"\\n}","type":"json"}]', 'title' => 'DescribeRCInstanceVncUrl', 'description' => 'The address returned is valid only for 15 seconds. If you do not use the returned address to establish a connection within 15 seconds, the address expires and you must call the operation again to obtain a new address.'."\n", ], 'DescribeRCNodePool' => [ 'summary' => 'Queries the configuration information about the edge node pool of an RDS Custom instance.', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'docRequired' => true, ], ], [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the ACK Edge cluster in which the RDS Custom instance resides.'."\n", 'type' => 'string', 'required' => false, 'example' => 'c463aaa89e2b84cacacfbf23c4867****'."\n", 'docRequired' => true, ], ], [ 'name' => 'NodePoolId', 'in' => 'query', 'schema' => [ 'description' => 'The node pool ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'np31da1b38983f4511b490fc62108a****'."\n", ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'C816A4BF-A6EC-4722-95F9-2055859CCFD2', ], 'NodePoolList' => [ 'description' => 'The node pool information.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ClusterId' => [ 'description' => 'The ID of the container cluster in which the RDS Custom instance resides.'."\n", 'type' => 'string', 'example' => 'c463aaa89e2b84cacacfbf23c4867****'."\n", ], 'NodePoolId' => [ 'description' => 'The node pool ID.'."\n", 'type' => 'string', 'example' => 'np31da1b38983f4511b490fc62108a****'."\n", ], 'SecurityEnhancementStrategy' => [ 'description' => 'The reserved parameter. This parameter is not supported.'."\n", 'type' => 'string', 'example' => 'None', ], 'DataDisk' => [ 'description' => 'The data disks.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the data disk.'."\n", 'type' => 'object', 'properties' => [ 'Category' => [ 'description' => 'The type of the data disk. Set the value to **cloud_essd**, which indicates Enterprise SSDs (ESSDs).'."\n", 'type' => 'string', 'example' => 'cloud_essd', ], 'DeleteWithInstance' => [ 'description' => 'The reserved parameter. This parameter is not supported.'."\n", 'type' => 'boolean', 'example' => 'None', ], 'Encrypted' => [ 'description' => 'Indicates whether to encrypt the cloud disk. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false** (default)'."\n", 'type' => 'string', 'example' => 'false', ], 'PerformanceLevel' => [ 'description' => 'The performance level of the ESSD. Valid values:'."\n" ."\n" .'* **PL0**: A single ESSD delivers up to 10,000 random read/write IOPS.'."\n" .'* **PL1**: A single ESSD delivers up to 50,000 random read/write IOPS.'."\n" .'* **PL2**: A single ESSD delivers up to 100,000 random read/write IOPS.'."\n" .'* **PL3**: A single ESSD delivers up to 1,000,000 random read/write IOPS.'."\n", 'type' => 'string', 'example' => 'PL0', ], 'Size' => [ 'description' => 'The data disk size. Unit: GiB.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], ], ], ], 'Tag' => [ 'description' => 'The tags.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The tag.'."\n", 'type' => 'object', 'properties' => [ 'Key' => [ 'description' => 'The tag keys.'."\n", 'type' => 'string', 'example' => 'Testkey1', ], 'Value' => [ 'description' => 'The tag value.'."\n", 'type' => 'string', 'example' => 'Testvalue1'."\n", ], ], ], ], 'DeploymentSetId' => [ 'description' => 'The ID of the deployment set.'."\n", 'type' => 'string', 'example' => 'ds-bp18ukv66rlyuffv****', ], 'Description' => [ 'description' => 'The instance description.'."\n", 'type' => 'string', 'example' => 'test', ], 'InstanceName' => [ 'description' => 'The instance name.'."\n", 'type' => 'string', 'example' => 'test', ], 'Password' => [ 'description' => 'The password of the root user of the instance.'."\n", 'type' => 'string', 'example' => 'testPassword'."\n", ], 'VSwitchId' => [ 'description' => 'The vSwitch ID.'."\n", 'type' => 'string', 'example' => 'vsw-zm0qvgv3sm3sjzbkr****', ], 'HostName' => [ 'description' => 'The instance hostname.'."\n", 'type' => 'string', 'example' => 'testHost1'."\n", ], 'InternetChargeType' => [ 'description' => 'The reserved parameter. This parameter is not supported.'."\n", 'type' => 'string', 'example' => 'None', ], 'ImageId' => [ 'description' => 'The ID of the image used by the instance.'."\n", 'type' => 'string', 'example' => 'image-dsvjzw2ii8n4fvr****', ], 'InstanceType' => [ 'description' => 'The instance type.'."\n", 'type' => 'string', 'example' => 'mysql.i8.large.2cm', ], 'InternetMaxBandwidthOut' => [ 'description' => 'The reserved parameter. This parameter is not supported.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => 'None', ], 'IoOptimized' => [ 'description' => 'The reserved parameter. This parameter is not supported.'."\n", 'type' => 'string', 'example' => 'None', ], 'KeyPairName' => [ 'description' => 'The key pair name.'."\n", 'type' => 'string', 'example' => 'dell5502', ], 'RegionId' => [ 'description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], 'SecurityGroupId' => [ 'description' => 'The security group ID.'."\n", 'type' => 'string', 'example' => 'sg-uf6av412xaxixuez****', ], 'AutoPay' => [ 'description' => 'Indicates whether to enable automatic payment. Valid values:'."\n" ."\n" .'* **true** (default): enables the feature. You must make sure that your account balance is sufficient.'."\n" .'* **false**: disables the feature. An unpaid order is generated.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'ZoneId' => [ 'description' => 'The zone ID.'."\n", 'type' => 'string', 'example' => 'cn-beijing-h', ], 'ResourceGroupId' => [ 'description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'example' => 'rg-acfmy****', ], 'InstanceChargeType' => [ 'description' => 'The billing method. Valid value:'."\n" ."\n" .'* **Prepaid**: subscription'."\n" .'* **Postpaid**: pay-as-you-go'."\n", 'type' => 'string', 'example' => 'Prepaid', ], 'SpotStrategy' => [ 'description' => 'The reserved parameter. This parameter is not supported.'."\n", 'type' => 'string', 'example' => 'None', ], 'SystemDisk' => [ 'description' => 'The specification of the system disk.'."\n", 'type' => 'object', 'properties' => [ 'Category' => [ 'description' => 'The type of the system disk. Set the value to **cloud_essd**, which indicates ESSDs.'."\n", 'type' => 'string', 'example' => 'cloud_essd', ], 'Size' => [ 'description' => 'The size of the system disk. Unit: GiB.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '40', ], 'PerformanceLevel' => [ 'description' => 'The performance level of the ESSD. Valid values:'."\n" ."\n" .'* **PL0**: A single ESSD delivers up to 10,000 random read/write IOPS.'."\n" .'* **PL1**: A single ESSD delivers up to 50,000 random read/write IOPS.'."\n" .'* **PL2**: A single ESSD delivers up to 100,000 random read/write IOPS.'."\n" .'* **PL3**: A single ESSD delivers up to 1,000,000 random read/write IOPS.'."\n", 'type' => 'string', 'example' => 'PL1', ], ], ], 'CreateMode' => [ 'description' => 'Indicates whether to add the instance to the ACK cluster.'."\n", 'type' => 'string', 'example' => '1', ], 'Period' => [ 'description' => 'The subscription duration.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PeriodUnit' => [ 'description' => 'The unit of the subscription period. Valid values:'."\n" ."\n" .'* **Year**'."\n" .'* **Month** (default)'."\n", 'type' => 'string', 'example' => 'Year', ], 'AutoRenew' => [ 'description' => 'Indicates whether to enable auto-renewal for the instance. Valid values:'."\n" ."\n" .'* **true** (default)'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'NodePoolName' => [ 'description' => 'The name of the node pool.'."\n", 'type' => 'string', 'example' => 'np31da1b38983f4511b490fc62108a****'."\n", ], ], 'description' => '', ], ], ], 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'NoAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for account. We recommend that you add a payment method.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C816A4BF-A6EC-4722-95F9-2055859CCFD2\\",\\n \\"NodePoolList\\": [\\n {\\n \\"ClusterId\\": \\"c463aaa89e2b84cacacfbf23c4867****\\\\n\\",\\n \\"NodePoolId\\": \\"np31da1b38983f4511b490fc62108a****\\\\n\\",\\n \\"SecurityEnhancementStrategy\\": \\"None\\",\\n \\"DataDisk\\": [\\n {\\n \\"Category\\": \\"cloud_essd\\",\\n \\"DeleteWithInstance\\": true,\\n \\"Encrypted\\": \\"false\\",\\n \\"PerformanceLevel\\": \\"PL0\\",\\n \\"Size\\": 20\\n }\\n ],\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"Testkey1\\",\\n \\"Value\\": \\"Testvalue1\\\\n\\"\\n }\\n ],\\n \\"DeploymentSetId\\": \\"ds-bp18ukv66rlyuffv****\\",\\n \\"Description\\": \\"test\\",\\n \\"InstanceName\\": \\"test\\",\\n \\"Password\\": \\"testPassword\\\\n\\",\\n \\"VSwitchId\\": \\"vsw-zm0qvgv3sm3sjzbkr****\\",\\n \\"HostName\\": \\"testHost1\\\\n\\",\\n \\"InternetChargeType\\": \\"None\\",\\n \\"ImageId\\": \\"image-dsvjzw2ii8n4fvr****\\",\\n \\"InstanceType\\": \\"mysql.i8.large.2cm\\",\\n \\"InternetMaxBandwidthOut\\": 0,\\n \\"IoOptimized\\": \\"None\\",\\n \\"KeyPairName\\": \\"dell5502\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"SecurityGroupId\\": \\"sg-uf6av412xaxixuez****\\",\\n \\"AutoPay\\": true,\\n \\"ZoneId\\": \\"cn-beijing-h\\",\\n \\"ResourceGroupId\\": \\"rg-acfmy****\\",\\n \\"InstanceChargeType\\": \\"Prepaid\\",\\n \\"SpotStrategy\\": \\"None\\",\\n \\"SystemDisk\\": {\\n \\"Category\\": \\"cloud_essd\\",\\n \\"Size\\": 40,\\n \\"PerformanceLevel\\": \\"PL1\\"\\n },\\n \\"CreateMode\\": \\"1\\",\\n \\"Period\\": 1,\\n \\"PeriodUnit\\": \\"Year\\",\\n \\"AutoRenew\\": true,\\n \\"NodePoolName\\": \\"np31da1b38983f4511b490fc62108a****\\\\n\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => 'DescribeRCNodePool', ], 'CreateRCNodePool' => [ 'summary' => 'Creates an edge node pool in the Container Service for Kubernetes (ACK) Edge cluster to which the RDS Custom instance belongs.', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'InstanceType', 'in' => 'query', 'schema' => [ 'description' => 'The instance type. For more information about the instance types that are supported by RDS Custom instances, see [Instance types for RDS Custom instances](~~2844823~~).'."\n", 'type' => 'string', 'required' => true, 'example' => 'mysql.i8.large.2cm'."\n", ], ], [ 'name' => 'Amount', 'in' => 'query', 'schema' => [ 'description' => 'The number of RDS Custom instances that you want to create. The parameter is available if you want to create multiple RDS Custom instances at a time.'."\n" ."\n" .'Valid values: **1** to **5**. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '10', 'minimum' => '0', 'example' => '1', 'default' => '0', ], ], [ 'name' => 'Period', 'in' => 'query', 'schema' => [ 'description' => 'The subscription duration of the instance. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1', ], ], [ 'name' => 'PeriodUnit', 'in' => 'query', 'schema' => [ 'description' => 'The unit of the subscription duration. Valid values:'."\n" ."\n" .'* **Year**'."\n" .'* **Month** (default)'."\n", 'type' => 'string', 'required' => false, 'example' => 'Year', 'default' => 'Month', 'enum' => [ 'Month', 'Year', ], ], ], [ 'name' => 'AutoRenew', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable auto-renewal for the instance. If you specify the subscription billing method for the instance, you must specify this parameter. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n" ."\n" .'> '."\n" ."\n" .'* Monthly subscription: The auto-renewal period is one month.'."\n" ."\n" .'* Annually: The auto-renewal period is one year.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'SecurityEnhancementStrategy', 'in' => 'query', 'schema' => [ 'description' => 'The reserved parameter. This parameter is not supported.'."\n", 'type' => 'string', 'required' => false, 'example' => 'None', ], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCz****', ], ], [ 'name' => 'Password', 'in' => 'query', 'schema' => [ 'description' => 'The password for the root account of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testPassword', ], ], [ 'name' => 'VSwitchId', 'in' => 'query', 'schema' => [ 'description' => 'The vSwitch ID.'."\n" ."\n" .'> The vSwitch must belong to the same zone as the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'vsw-uf6adz52c2p****', ], ], [ 'name' => 'DataDisk', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The data disks.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the data disk.'."\n", 'type' => 'object', 'properties' => [ 'Category' => [ 'description' => 'The type of the data disk. Set the value to **cloud_essd**, which indicates Enterprise SSDs (ESSDs).'."\n", 'type' => 'string', 'required' => false, 'example' => 'cloud_essd', ], 'DeleteWithInstance' => [ 'description' => 'The reserved parameter. This parameter is not supported.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'None', ], 'Encrypted' => [ 'description' => 'Specifies whether to encrypt the data disk. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false** (default)'."\n", 'type' => 'string', 'required' => false, 'example' => 'false', ], 'PerformanceLevel' => [ 'description' => 'The performance level of the ESSD. Valid values:'."\n" ."\n" .'* **PL0**: A single ESSD delivers up to 10,000 random read/write IOPS.'."\n" .'* **PL1**: A single ESSD delivers up to 50,000 random read/write IOPS.'."\n" .'* **PL2**: A single ESSD delivers up to 100,000 random read/write IOPS.'."\n" .'* **PL3**: A single ESSD delivers up to 1,000,000 random read/write IOPS.'."\n", 'type' => 'string', 'required' => false, 'example' => 'PL1', ], 'Size' => [ 'description' => 'The size of the data disk. Unit: GiB. Valid values: 20 to 65536.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], 'required' => false, ], 'required' => false, ], ], [ 'name' => 'InstanceName', 'in' => 'query', 'schema' => [ 'description' => 'The instance name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', ], ], [ 'name' => 'DeploymentSetId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the deployment set.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ds-uf6c8qerk019bj1l****', ], ], [ 'name' => 'InternetChargeType', 'in' => 'query', 'schema' => [ 'description' => 'The reserved parameter. This parameter is not supported.'."\n", 'type' => 'string', 'required' => false, 'example' => 'None', ], ], [ 'name' => 'InternetMaxBandwidthOut', 'in' => 'query', 'schema' => [ 'description' => 'The reserved parameter. This parameter is not supported.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => 'None', ], ], [ 'name' => 'SecurityGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the security group. You can enter an existing security group ID. If no security groups exist, a security group is automatically created.'."\n", 'type' => 'string', 'required' => false, 'example' => 'sg-m5e9abdu1rtxa12b****', ], ], [ 'name' => 'ZoneId', 'in' => 'query', 'schema' => [ 'description' => 'The zone ID of the instance.'."\n" ."\n" .'> If you specify the VSwitchId parameter, the zone specified by the ZoneId parameter must be the same as the zone in which the specified vSwitch resides. You can leave the ZoneId parameter empty. In this case, the system uses the zone in which the specified vSwitch resides.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-b', ], ], [ 'name' => 'IoOptimized', 'in' => 'query', 'schema' => [ 'description' => 'The reserved parameter. This parameter is not supported.'."\n", 'type' => 'string', 'required' => false, 'example' => 'None', ], ], [ 'name' => 'ImageId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the image used by the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'image-dsvjzw2ii8n4fvr6de', ], ], [ 'name' => 'SystemDisk', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The specification of the system disk.'."\n", 'type' => 'object', 'properties' => [ 'Category' => [ 'description' => 'The type of the system disk. Set the value to **cloud_essd**, which indicates ESSDs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cloud_essd', ], 'Size' => [ 'description' => 'The size of the system disk. Unit: GiB. Valid values: 20 to 2048.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '40', ], 'PerformanceLevel' => [ 'description' => 'The performance level of the ESSD. Valid values:'."\n" ."\n" .'* **PL0**: A single ESSD delivers up to 10,000 random read/write IOPS.'."\n" .'* **PL1**: A single ESSD delivers up to 50,000 random read/write IOPS.'."\n" .'* **PL2**: A single ESSD delivers up to 100,000 random read/write IOPS.'."\n" .'* **PL3**: A single ESSD delivers up to 1,000,000 random read/write IOPS.'."\n", 'type' => 'string', 'required' => false, 'example' => 'PL1', ], ], 'required' => false, ], ], [ 'name' => 'InstanceChargeType', 'in' => 'query', 'schema' => [ 'description' => 'The billing method of the instance. Valid values:'."\n" ."\n" .'* **Prepaid**: subscription.'."\n" .'* **Postpaid**: pay-as-you-go.'."\n", 'type' => 'string', 'required' => false, 'example' => 'PrePaid', ], ], [ 'name' => 'AutoPay', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable automatic payment. Valid values:'."\n" ."\n" .'* **true**: enables the feature. Make sure that your account balance is sufficient when you enable automatic payment.'."\n" .'* **false**: does not automatically complete the payment. An unpaid order is generated.'."\n" ."\n" .'> Default value: true. If your account balance is insufficient, you can set AutoPay to false to generate an unpaid order. Then, you can log on to the ApsaraDB RDS console to complete the payment.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'true', ], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => [ 'description' => 'The instance description. The description must be 2 to 256 characters in length and cannot start with http:// or https://.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', ], ], [ 'name' => 'KeyPairName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the AccessKey pair. You can specify only one name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'dell5502', ], ], [ 'name' => 'DryRun', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to perform a dry run. Default value: false. Valid values:'."\n" ."\n" .'* **true**: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, service limits, and insufficient inventory errors.'."\n" .'* **false** (default): performs a dry run and performs the actual request. If the request passes the dry run, the instance is directly created.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The tags.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The tag.'."\n", 'type' => 'object', 'properties' => [ 'Key' => [ 'description' => 'The key of the tag. You can create N tag keys at a time. Valid values of N: **1 to 20**. This parameter cannot be an empty string.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testkey1', ], 'Value' => [ 'description' => 'The tag value. You can create N tag values at a time. Valid values of N: **1** to **20**. This parameter can be an empty string.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testvalue1', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 21, ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy****', ], ], [ 'name' => 'CreateMode', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to add the instance to the ACK cluster. If this parameter is set to **1**, the created instances can be added to the ACK cluster. This allows you to efficiently manage container applications. Valid values:'."\n" ."\n" .'* **1**: adds the instance to the ACK cluster.'."\n" .'* **0** (default): does not add the instance to the ACK cluster.'."\n", 'type' => 'string', 'required' => false, 'example' => '1', ], ], [ 'name' => 'HostName', 'in' => 'query', 'schema' => [ 'description' => 'The instance hostname.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testHost1', ], ], [ 'name' => 'SpotStrategy', 'in' => 'query', 'schema' => [ 'description' => 'The reserved parameter. This parameter is not supported.'."\n", 'type' => 'string', 'required' => false, 'example' => 'None', ], ], [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the ACK cluster to which the RDS Custom instance belongs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'c463aaa89e2b84cacacfbf23c4867****', ], ], [ 'name' => 'NodePoolName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the node pool.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testNodePool', ], ], [ 'name' => 'SupportCase', 'in' => 'query', 'schema' => [ 'description' => 'The supported scenario. If you set the **createMode** parameter to **1**, you must also specify the SupportCase parameter. Valid value: **edge**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'edge', ], ], [ 'name' => 'UserData', 'in' => 'query', 'schema' => [ 'description' => 'The reserved parameter. This parameter is not supported.'."\n", 'type' => 'string', 'required' => false, 'example' => 'None', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '08A3B71B-FE08-4B03-974F-CC7EA6DB1828', ], 'InstanceIdSets' => [ 'description' => 'The instance IDs.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => '{\'InstanceIdSet\': [\'rc-x0a263765axt7e****\']}', ], ], 'OrderId' => [ 'description' => 'The order ID.'."\n", 'type' => 'string', 'example' => '50357661918****', ], 'NodePoolId' => [ 'description' => 'The node pool ID.'."\n", 'type' => 'string', 'example' => 'np31da1b38983f4511b490fc62108a****', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidUserAccount.NotSupported', 'errorMessage' => 'the Specified user account Validated not supported.', ], [ 'errorCode' => 'InvalidInstanceType.NotSupportDiskCategory', 'errorMessage' => 'The instanceType of the specified instance does not support this disk category.', ], [ 'errorCode' => 'InvalidInstanceType.ZoneNotSupported', 'errorMessage' => 'The specified zone does not support this instancetype.', ], [ 'errorCode' => 'InvalidInstanceType.NotSupported', 'errorMessage' => 'The specified instance type is not supported.', ], [ 'errorCode' => 'InvalidImageId.NotFound', 'errorMessage' => 'The specified ImageId does not exist.', ], [ 'errorCode' => 'InsufficientCapacity', 'errorMessage' => 'There is insufficient capacity available for the requested resource.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'InvalidPayType.NotSupported', 'errorMessage' => 'current instance pay type not support this operation.', ], [ 'errorCode' => 'InvalidTargetDBInstanceName.NotFound', 'errorMessage' => 'The specified DB instance name does not exist.', ], [ 'errorCode' => 'InvalidParameters.ImageId', 'errorMessage' => 'The specified image does not support the specified InstanceType.', ], [ 'errorCode' => 'InvalidDataDiskSize.ValueNotSupported', 'errorMessage' => 'The specified DataDisk.n.Size beyond the permitted range, or the capacity of snapshot exceeds the size limit of the specified disk category.', ], [ 'errorCode' => 'InvalidParameters.SystemSize', 'errorMessage' => 'SystemDisk size is invalid.', ], [ 'errorCode' => 'InvalidHostName.CustomMalformed', 'errorMessage' => 'Customized section of host name is invalid, please use valid format: [], [,], [m,], [,n], [m,n].', ], [ 'errorCode' => 'InvalidParameter.AckEdgeParam', 'errorMessage' => 'The specified AckEdgeParam is not valid.', ], [ 'errorCode' => 'InvalidParameter.AckMode', 'errorMessage' => 'CreteMode should be 1 and SupportCase should be edge.', ], [ 'errorCode' => 'InvalidParameter.AutoPay', 'errorMessage' => 'AutoPay should be true.', ], [ 'errorCode' => 'InvalidDescription.Malformed', 'errorMessage' => 'The specified parameter "Description" is not valid.', ], [ 'errorCode' => 'InvalidDiskSize.NotSupported', 'errorMessage' => 'The specified parameter size is not valid.', ], [ 'errorCode' => 'InvalidPassword.Malformed', 'errorMessage' => 'The specified parameter "Password" is not valid.', ], [ 'errorCode' => 'InvalidPerformanceLevel.Malformed', 'errorMessage' => 'The specified parameter DataDisk.n.PerformanceLevel is not valid.', ], [ 'errorCode' => 'InvalidSystemDiskCategory.ValueNotSupported', 'errorMessage' => 'The current operation does not support this system disk type.', ], [ 'errorCode' => 'IncorrectInstanceStatus', 'errorMessage' => 'The current status of the resource does not support this operation.', ], [ 'errorCode' => 'IncorrectInstanceStatus.Initializing', 'errorMessage' => 'The specified instance status does not support this operation.', ], [ 'errorCode' => 'InvalidDataDiskCategory.NotSupported', 'errorMessage' => 'Specified disk category is not supported.', ], [ 'errorCode' => 'InvalidDevice.Malformed', 'errorMessage' => 'The specified device is not valid.', ], [ 'errorCode' => 'InvalidDiskCategory.ValueNotSupported', 'errorMessage' => 'Specified disk category is not supported.', ], [ 'errorCode' => 'InvalidUserData.SizeExceed', 'errorMessage' => 'The UserData is invalid, the size of UserData should not greater than 32KB.', ], [ 'errorCode' => 'InvalidZoneId.DiskCategoryUnsupported', 'errorMessage' => 'The specified disk category does not support setting the ZoneId.', ], ], 403 => [ [ 'errorCode' => 'InvalidSecurityGroupId.NotFound', 'errorMessage' => 'The specified SecurityGroupId does not found.', ], [ 'errorCode' => 'InvalidInstanceType.NotSupported', 'errorMessage' => 'The specified InstanceType is not Supported.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], [ 'errorCode' => 'OperationDenied.SystemConcurrent', 'errorMessage' => 'Failure caused by Concurrent operations.', ], [ 'errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'Arguments on this idempotent request are inconsistent with arguments used in previous request(s).', ], [ 'errorCode' => 'InstanceDiskNumLimitExceed', 'errorMessage' => 'The number of specified disk in an instance exceeds.', ], [ 'errorCode' => 'DiskCategory.OperationNotSupported', 'errorMessage' => 'The type of the specified disk does not support creating a snapshot.', ], [ 'errorCode' => 'IncorrectDiskStatus.CreatingSnapshot', 'errorMessage' => 'A previous snapshot creation is in process.', ], [ 'errorCode' => 'IncorrectInstanceStatus.NotSupportESSD', 'errorMessage' => 'The operation is not supported in this status, please reboot the instance.', ], [ 'errorCode' => 'InvalidOperation.InstanceTypeNotSupport', 'errorMessage' => 'The instance type of the specified instance does not support hot detach disk.', ], [ 'errorCode' => 'OperationDenied.IncorrectDiskStatus', 'errorMessage' => 'The current disk status does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'The specified parameter is invalid.', ], [ 'errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], [ 'errorCode' => 'DeploymentSet.NotFound', 'errorMessage' => 'The specified deployment set does not exist.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"08A3B71B-FE08-4B03-974F-CC7EA6DB1828\\",\\n \\"InstanceIdSets\\": [\\n \\"{\'InstanceIdSet\': [\'rc-x0a263765axt7e****\']}\\"\\n ],\\n \\"OrderId\\": \\"50357661918****\\",\\n \\"NodePoolId\\": \\"np31da1b38983f4511b490fc62108a****\\"\\n}","type":"json"}]', 'title' => 'CreateRCNodePool', ], 'RenewRCInstance' => [ 'summary' => 'Renews a subscription RDS Custom instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'high', 'chargeType' => 'paid', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOC****', ], ], [ 'name' => 'CommodityCode', 'in' => 'query', 'schema' => [ 'description' => 'The commodity code of the instance.'."\n" ."\n" .'Default value: **rds_customprepaid_public_intl**.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rds_customprepaid_public_**', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the RDS Custom instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rc-dh2jf9n6j4s14926****', ], ], [ 'name' => 'UsedTime', 'in' => 'query', 'schema' => [ 'description' => 'The subscription duration of the instance. Valid values:'."\n" ."\n" .'* If you set the **TimeType** parameter to **1**, the value of the UsedTime parameter ranges from **1 to 5**. Unit: year.'."\n" .'* If you set the **TimeType** parameter to **2**, the value of the UsedTime parameter ranges from **1 to 11**. Unit: month.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1', ], ], [ 'name' => 'TimeType', 'in' => 'query', 'schema' => [ 'description' => 'The unit of the renewal period specified by the **UsedTime** parameter. Valid values:'."\n" ."\n" .'* **1**: year'."\n" .'* **2** (default): month'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2', ], ], [ 'name' => 'Resource', 'in' => 'query', 'schema' => [ 'description' => 'The resources.'."\n", 'type' => 'string', 'required' => false, 'example' => 'buy', ], ], [ 'name' => 'AutoPay', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable automatic payment. Valid values:'."\n" ."\n" .'* **true**: enables the feature. You must make sure that your account balance is sufficient.'."\n" .'* **false**: disables the feature. An unpaid order is generated.'."\n" ."\n" .'> Default value: true. If your account balance is insufficient, you can set AutoPay to false to generate an unpaid order. Then, you can log on to the ApsaraDB RDS console to complete the payment.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'PayType', 'in' => 'query', 'schema' => [ 'description' => 'The billing method of the instance. Set the value to **PrePaid**, which indicates the subscription billing method.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Prepaid', ], ], [ 'name' => 'BusinessInfo', 'in' => 'query', 'schema' => [ 'description' => 'The additional information about the order.'."\n", 'type' => 'string', 'required' => false, 'example' => '{\\"promotion_input_param\\":\\"{\\\\\\"promotionFilter\\\\\\":{},\\\\\\"promotionOptionCode\\\\\\":\\\\\\"youhui_quan\\\\\\"}\\"}', ], ], [ 'name' => 'PeriodAlign', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether the instance is a subscription instance. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false** (default)'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'AutoRenew', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable auto-renewal for the instance. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false** (default)'."\n", 'type' => 'string', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'AutoUseCoupon', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to use a coupon. Default value: false. Valid values:'."\n" ."\n" .'* **true**: uses a coupon.'."\n" .'* **false**: does not use a coupon.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true', ], ], [ 'name' => 'PromotionCode', 'in' => 'query', 'schema' => [ 'description' => 'The coupon code.'."\n", 'type' => 'string', 'required' => false, 'example' => '72329885****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'DBInstanceId' => [ 'description' => 'The ID of the RDS Custom instance.'."\n", 'type' => 'string', 'example' => 'rc-dh2jf9n6j4s14926****'."\n", ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'EFFC7565-B3CF-5CFA-9E1F-164DD1E1F498', ], 'OrderIds' => [ 'description' => 'The order ID.'."\n", 'type' => 'string', 'example' => '23202700556****', ], 'OrderId' => [ 'type' => 'string', ], ], 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'QueryPrice Failed.', ], [ 'errorCode' => 'FUWU_BIZ_COMMODITY_VERIFY_FAIL', 'errorMessage' => 'There are arrears orders.', ], [ 'errorCode' => 'InvalidEngine.VauleNotSupported', 'errorMessage' => 'The specified parameter "Engine" is not valid.', ], [ 'errorCode' => 'InvalidEngineVersion.ValueNotSupported', 'errorMessage' => 'The specified parameter "EngineVersion" is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceClass.ValueNotSupported', 'errorMessage' => 'The specified parameter "DBInstanceClass" is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceStorage.ValueNotSupported', 'errorMessage' => 'The specified parameter "DBInstanceStorage" is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceNetType.ValueNotSupported', 'errorMessage' => 'The specified parameter "InvalidDBInstanceNetType" is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceDescription.Malformed', 'errorMessage' => 'The specified parameter "DBInstanceDescription" is not valid.', ], [ 'errorCode' => 'InvalidSecurityIPList.Malformed', 'errorMessage' => 'The specified parameter "SecurityIPList" is not valid.', ], [ 'errorCode' => 'InvalidSecurityIPList.Duplicate', 'errorMessage' => 'The Security IP address is not in the available range or occupied.', ], [ 'errorCode' => 'InvalidSecurityIPListLength.Malformed', 'errorMessage' => 'The quota of security ip exceeds.', ], [ 'errorCode' => 'IncompleteAccountInfo', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'IncompleteTaxInfo', 'errorMessage' => 'Your tax information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'InvalidPaymentMethod.Incomplete', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'InvalidPaymentMethod.Missing', 'errorMessage' => 'Your payment method is incomplete. We recommend that you add a payment method.', ], [ 'errorCode' => 'InsuffcientBalanceOrBankAccount', 'errorMessage' => 'Add a payment method or add funds to the prepayment balance. Get started by creating an instance.', ], [ 'errorCode' => 'VswitchIpExhausted', 'errorMessage' => 'Vswitch IP exhausted.', ], [ 'errorCode' => 'OperationDenied.InvalidStorageSize', 'errorMessage' => 'The storage size limit is exceeded.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'Order.InstHasUnsettledBills', 'errorMessage' => 'You currently have outstanding bills, please settle them first.', ], [ 'errorCode' => 'InvalidParam.UsedTime', 'errorMessage' => 'The renewal expiration date cannot exceed:%s.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'StopService.Renew', 'errorMessage' => 'The service has been discontinued and renewal operations for instances on the classic network are no longer allowed.', ], [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The specified DB instance name does not exist.', ], [ 'errorCode' => 'InvalidOrderTask.NotSupport', 'errorMessage' => 'The Current InstanceId exist Order Task in RDS.', ], ], 403 => [ [ 'errorCode' => 'InvalidEngineVersionInRegion.NotAvailable', 'errorMessage' => 'The EngineVersion in the Region is not available.', ], [ 'errorCode' => 'InvaildEngineInRegion.NotAvailable', 'errorMessage' => 'The Engine in the Region is not available.', ], [ 'errorCode' => 'OperationDenied', 'errorMessage' => 'The resource is out of usage.', ], [ 'errorCode' => 'RegionUnauthorized', 'errorMessage' => 'There is no authority to create instance in the specified region.', ], [ 'errorCode' => 'QuotaExceeded.CreateInstance', 'errorMessage' => 'The quota of create instance exceeds.', ], [ 'errorCode' => 'Forbidden.Authentication', 'errorMessage' => 'The operation is forbidden by Aliyun Realname Authentication System.', ], [ 'errorCode' => 'INST_HAS_UNPAID_ORDER', 'errorMessage' => 'The instanceId has unpaid order.', ], [ 'errorCode' => 'COMMODITY.FAILED', 'errorMessage' => 'The commodity is error.', ], [ 'errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', ], [ 'errorCode' => 'InvalidOrderCharge.NotPay', 'errorMessage' => 'The specified parameter OrderCharge is not pay.', ], [ 'errorCode' => 'OperationDenied.NotSupportedBackupMethod', 'errorMessage' => 'When the storage is larger than 4000 GB, only snapshot backup is supported.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The provided InstanceId does not exist.', ], [ 'errorCode' => 'canNotFindSubscription', 'errorMessage' => 'Subscription information not found.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], [ 'errorCode' => 'InvalidOrderCharge.NotSupport', 'errorMessage' => 'Specified order charge does not support in RDS.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DBInstanceId\\": \\"rc-dh2jf9n6j4s14926****\\\\n\\",\\n \\"RequestId\\": \\"EFFC7565-B3CF-5CFA-9E1F-164DD1E1F498\\",\\n \\"OrderIds\\": \\"23202700556****\\",\\n \\"OrderId\\": \\"23202700556****\\"\\n}","type":"json"}]', 'title' => 'RenewRCInstance', ], 'AuthorizeRCSecurityGroupPermission' => [ 'summary' => 'Adds rules to the specified security group.', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'docRequired' => true, ], ], [ 'name' => 'SecurityGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the security group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'sg-2ze27hs990o2hn9****', 'docRequired' => true, ], ], [ 'name' => 'SecurityGroupPermissions', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The information about the security group.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the security group.'."\n", 'type' => 'object', 'properties' => [ 'Policy' => [ 'description' => 'The action that you want to specify in the rule.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Accept', ], 'Priority' => [ 'description' => 'The priority of the rule. Valid values: 1 to 100. A smaller value indicates a higher priority. When multiple security group rules have the same priority, drop rules take precedence.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'IpProtocol' => [ 'description' => 'The protocol type supported by the rule. The value is not case-sensitive. Valid values:'."\n" ."\n" .'* **ICMP**'."\n" .'* **GRE**'."\n" .'* **TCP**'."\n" .'* **UDP**'."\n" .'* **ALL**: All protocols are supported.'."\n", 'type' => 'string', 'required' => false, 'example' => 'TCP', ], 'SourceCidrIp' => [ 'description' => 'The source CIDR block for inbound access control. CIDR blocks and IPv4 addresses are supported.'."\n", 'type' => 'string', 'required' => false, 'example' => '192.168.0.1/12', ], 'PortRange' => [ 'description' => 'The range of destination ports that correspond to the transport layer protocol of the destination security group. Valid values:'."\n" ."\n" .'* The value is in the X/Y format when IpProtocol is set to TCP or UDP. X specifies the start port number and Y specifies the end port number. X and Y range from **1** to **65535**. The start port number and the end port number are separated by a forward slash (/). Correct example: **1/200**. Incorrect example: **200/1**.'."\n" .'* Valid value when IpProtocol is set to ICMP: **-1/-1**.'."\n" .'* Valid value when IpProtocol is set to GRE: **-1/-1**.'."\n" .'* Valid value when IpProtocol is set to ALL: **-1/-1**.'."\n", 'type' => 'string', 'required' => false, 'example' => '80/80', ], 'DestCidrIp' => [ 'description' => 'The destination CIDR block for outbound access control. CIDR blocks and IPv4 addresses are supported.'."\n", 'type' => 'string', 'required' => false, 'example' => '192.168.0.1/12'."\n", ], 'SourcePortRange' => [ 'description' => 'The range of port numbers that correspond to the transport layer protocol for the source security group. Valid values:'."\n" ."\n" .'* The value is in the X/Y format when IpProtocol is set to TCP or UDP. X specifies the start port number and Y specifies the end port number. X and Y range from **1** to **65535**. The start port number and the end port number are separated by a forward slash (/). Correct example: **1/200**. Incorrect example: **200/1**.'."\n" .'* Valid value when IpProtocol is set to ICMP: **-1/-1**.'."\n" .'* Valid value when IpProtocol is set to GRE: **-1/-1**.'."\n" .'* Valid value when IpProtocol is set to ALL: **-1/-1**.'."\n", 'type' => 'string', 'required' => false, 'example' => '80/80', ], ], 'required' => false, ], 'required' => false, 'docRequired' => true, ], ], [ 'name' => 'Direction', 'in' => 'query', 'schema' => [ 'description' => 'The direction of the rule. Valid values:'."\n" ."\n" .'* **ingress**: the inbound security group rule.'."\n" .'* **egress**: the outbound security group rule.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ingress'."\n", 'docRequired' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '0688F1D2-CDA8-5617-A43C-ADAC61D80D43', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'NoAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for account. We recommend that you add a payment method.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0688F1D2-CDA8-5617-A43C-ADAC61D80D43\\"\\n}","type":"json"}]', 'title' => 'AuthorizeRCSecurityGroupPermission', ], 'DescribeHistoryEventsStat' => [ 'summary' => 'Queries the statistics of historical events in the event center.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => [ 'description' => 'The region ID. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-beijing', ], ], [ 'name' => 'ArchiveStatus', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => [ 'description' => 'The status of the asset instance. Valid values: **starting**, **running**, **stopping**, and **stopped**.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'starting', ], ], [ 'name' => 'FromStartTime', 'in' => 'query', 'schema' => [ 'description' => 'The beginning of the time range to query. Only tasks that have a start time later than or equal to the time specified by this parameter are queried. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. The start time can be up to 30 days earlier than the current time. If you set this parameter to a time more than 30 days earlier than the current time, this time is automatically converted to a time that is exactly 30 days earlier than the current time.'."\n", 'type' => 'string', 'required' => false, 'example' => '2022-01-02T11:31:03Z', ], ], [ 'name' => 'ToStartTime', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => [ 'description' => 'The end of the time range to query. Only tasks that have a start time earlier than or equal to the time specified by this parameter are queried. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2022-03-02T11:31:03Z', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'Items' => [ 'description' => 'The event.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'EventCategory' => [ 'description' => 'The system event category. For more information, see [View the event history of an ApsaraDB RDS instance](~~129759~~).'."\n", 'type' => 'string', 'example' => 'Exception', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '31', ], ], ], ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'E52666CC-330E-418A-8E5B-A19E3FB42D13', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Param.Invalid', 'errorMessage' => 'Param invalid', ], [ 'errorCode' => 'Param.Invalid.TimeEndBeforeStart', 'errorMessage' => 'Param invalid. End time before start time', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'InvalidRequest', 'errorMessage' => 'Invalid Request.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Items\\": [\\n {\\n \\"EventCategory\\": \\"Exception\\",\\n \\"TotalCount\\": 31\\n }\\n ],\\n \\"RequestId\\": \\"E52666CC-330E-418A-8E5B-A19E3FB42D13\\"\\n}","type":"json"}]', 'title' => 'DescribeHistoryEventsStat', ], 'DescribeHistoryEvents' => [ 'summary' => 'Queries historical events in the event center.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => [ 'description' => 'The region ID. You can call the [DescribeRegions](~~610399~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-beijing', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page. Default value: 30.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '10', 'example' => '10', 'default' => '10', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => 'The page number. Pages start from page 1. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'default' => '1', ], ], [ 'name' => 'ArchiveStatus', 'in' => 'query', 'schema' => [ 'description' => 'The resource status. Valid values: **importing**, failed, checksuccess, and deleted.'."\n", 'type' => 'string', 'required' => false, 'example' => 'deleted', ], ], [ 'name' => 'EventCategory', 'in' => 'query', 'schema' => [ 'description' => 'The system event category. For more information, see [View the event history of an ApsaraDB RDS instance](~~129759~~).'."\n", 'type' => 'string', 'required' => false, 'example' => 'Exception', ], ], [ 'name' => 'EventType', 'in' => 'query', 'schema' => [ 'description' => 'The system event type. This parameter takes effect only when InstanceEventType.N is not specified. Valid values:'."\n" ."\n" .'* SystemMaintenance.Reboot: The instance is restarted due to system maintenance.'."\n" .'* SystemMaintenance.Redeploy: The instance is redeployed due to system maintenance.'."\n" .'* SystemFailure.Reboot: The instance is restarted due to a system error.'."\n" .'* SystemFailure.Redeploy: The instance is redeployed due to a system error.'."\n" .'* SystemFailure.Delete: The instance is released due to an instance creation failure.'."\n" .'* InstanceFailure.Reboot: The instance is restarted due to an instance error.'."\n" .'* InstanceExpiration.Stop: The subscription instance is stopped due to expiration.'."\n" .'* InstanceExpiration.Delete: The subscription instance is released due to expiration.'."\n" .'* AccountUnbalanced.Stop: The pay-as-you-go instance is stopped due to an overdue payment.'."\n" .'* AccountUnbalanced.Delete: The pay-as-you-go instance is released due to an overdue payment.'."\n" ."\n" .'> For more information, see Overview. The values of this parameter are applicable only to instance system events, but not to disk system events.'."\n", 'type' => 'string', 'required' => false, 'example' => 'SystemFailure.Reboot', ], ], [ 'name' => 'EventLevel', 'in' => 'query', 'schema' => [ 'description' => 'The event level. Valid values: ***high***, **medium**, and **low**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'high', ], ], [ 'name' => 'EventStatus', 'in' => 'query', 'schema' => [ 'description' => 'The status of the exception. Valid values:'."\n" ."\n" .'* 1: pending'."\n" .'* 2: ignored'."\n" .'* 4: confirmed'."\n" .'* 8: marked as false positive'."\n" .'* 16: handling'."\n" .'* 32: handled'."\n" .'* 64: expired'."\n", 'type' => 'string', 'required' => false, 'example' => '1', ], ], [ 'name' => 'ResourceType', 'in' => 'query', 'schema' => [ 'description' => 'The resource type. Set the value to **INSTANCE**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'INSTANCE', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rm-uf62br2491p5l****', ], ], [ 'name' => 'EventId', 'in' => 'query', 'schema' => [ 'description' => 'The event ID.'."\n", 'type' => 'string', 'required' => false, 'example' => '5345398', ], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'description' => 'The task ID. This value is used to query the data of a specific task.'."\n", 'type' => 'string', 'required' => false, 'example' => '241535739', ], ], [ 'name' => 'FromStartTime', 'in' => 'query', 'schema' => [ 'description' => 'The beginning of the time range to query. Only tasks that have a start time later than or equal to the time specified by this parameter are queried. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. The start time can be up to 30 days earlier than the current time. If you set this parameter to a time more than 30 days earlier than the current time, this time is automatically converted to a time that is exactly 30 days earlier than the current time.'."\n", 'type' => 'string', 'required' => true, 'example' => '2022-01-02T11:31:03Z', ], ], [ 'name' => 'ToStartTime', 'in' => 'query', 'schema' => [ 'description' => 'The end of the time range to query. Only tasks that have a start time earlier than or equal to the time specified by this parameter are queried. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => true, 'example' => '2023-01-12T07:06:19Z', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Items' => [ 'description' => 'The events.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The details of the data.'."\n", 'type' => 'object', 'properties' => [ 'CmsProduct' => [ 'description' => 'The cloud service type of the application group. Valid values: **web** and native. The value web indicates a web application. The value **native** indicates a local application.'."\n", 'type' => 'string', 'example' => 'web', ], 'DbType' => [ 'description' => 'The database engine.'."\n", 'type' => 'string', 'example' => 'mysql', ], 'DetailImpact' => [ 'description' => 'The pagination parameter.'."\n", 'type' => 'string', 'example' => '1', ], 'DetailReason' => [ 'description' => 'The details of the instance operation.'."\n", 'type' => 'string', 'example' => 'xxxx', ], 'EndTime' => [ 'description' => 'The time when the alert was closed. The time follows the ISO 8601 standard in the *yyyy-mm-dd*t*hh:mm*z format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2023-03-06T11:46:01Z', ], 'EventCategory' => [ 'description' => 'The system event category. For more information, see [View the event history of an ApsaraDB RDS instance](~~129759~~).'."\n", 'type' => 'string', 'example' => 'Exception', ], 'EventCode' => [ 'description' => 'The event code.'."\n", 'type' => 'string', 'example' => 'ENT000014', ], 'EventDetail' => [ 'description' => 'The event details.'."\n", 'type' => 'string', 'example' => 'xxxxx', ], 'EventId' => [ 'description' => 'The event ID.'."\n", 'type' => 'string', 'example' => '669036', ], 'EventImpact' => [ 'description' => 'The event impact.'."\n", 'type' => 'string', 'example' => 'xxxxx', ], 'EventLevel' => [ 'description' => 'The event level. For more information, see [View the event history of an ApsaraDB RDS instance](~~129759~~).'."\n", 'type' => 'string', 'example' => 'high', ], 'EventReason' => [ 'description' => 'The event source.'."\n", 'type' => 'string', 'example' => 'xxxxx', ], 'EventStatus' => [ 'description' => 'The status of the alert event. Valid values:'."\n" ."\n" .'* **1**: pending'."\n" .'* **2**: ignored'."\n" .'* **4**: confirmed'."\n" .'* **8**: marked as false positive'."\n" .'* **16**: handling'."\n" .'* **32**: handled'."\n" .'* **64**: expired'."\n", 'type' => 'string', 'example' => '1', ], 'EventType' => [ 'description' => 'The event type. Valid values:'."\n", 'type' => 'string', 'example' => 'StatusNotification', ], 'GmtCreated' => [ 'description' => 'The creation time. The time follows the ISO 8601 standard in the *yyyy-mm-dd*t*hh:mm*z format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2023-03-17T16:05:40Z', ], 'GmtModified' => [ 'description' => 'The update time. The time follows the ISO 8601 standard in the *yyyy-mm-dd*t*hh:mm*z format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2022-12-14T09:44:39.000+0000', ], 'HandleStatus' => [ 'description' => 'The handling status.'."\n", 'type' => 'string', 'example' => 'done', ], 'HasLifeCycle' => [ 'description' => 'Indicates whether the event has a lifecycle.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => 'false', ], 'InstanceId' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rg-acfmy****', ], 'InstanceName' => [ 'description' => 'The instance name.'."\n", 'type' => 'string', 'example' => 'dhimgsearch', ], 'IsClosed' => [ 'description' => 'Indicates whether the alert is closed. Valid values: **0**: closed. **1**: not closed.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'Product' => [ 'description' => 'The service name.'."\n", 'type' => 'string', 'example' => 'rds', ], 'RegionId' => [ 'description' => 'The region ID. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'example' => 'cn-guangzhou', ], 'ResourceType' => [ 'description' => 'The resource type. The value is fixed as **INSTANCE**.'."\n", 'type' => 'string', 'example' => 'INSTANCE', ], 'SourceType' => [ 'description' => 'The type of the source data.'."\n", 'type' => 'string', 'example' => 'MSE', ], 'StartTime' => [ 'description' => 'The start time. The time follows the ISO 8601 standard in the *yyyy-mm-dd*t*hh:mm*z format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2022-11-29T07:23Z', ], 'Uid' => [ 'description' => 'The ID of the resource owner.'."\n", 'type' => 'string', 'example' => '16986832xxxxx', ], ], ], 'Id' => [ 'description' => 'The task ID'."\n", 'type' => 'string', 'example' => '4309', ], 'Region' => [ 'description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-beijing', ], 'Source' => [ 'description' => 'The event source.'."\n", 'type' => 'string', 'example' => 'loanBill', ], 'Specversion' => [ 'description' => 'The database engine version.'."\n", 'type' => 'string', 'example' => '8.0', ], 'Subject' => [ 'description' => 'The name of the pending event.'."\n", 'type' => 'string', 'example' => 'QiTian', ], 'Time' => [ 'description' => 'The amount of time that has elapsed from the start time of the query. Unit: seconds.'."\n", 'type' => 'string', 'example' => '1675232573125', ], 'Type' => [ 'description' => 'The event type. For more information, see [View the event history of an ApsaraDB RDS instance](~~129759~~).'."\n", 'type' => 'string', 'example' => 'host', ], ], ], ], 'PageNumber' => [ 'description' => 'The page number. Valid values: any non-zero positive integer. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries per page. Default value: 30.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '7A41C147-C8D0-4DAE-A1A2-17EBCD60DFA1', ], 'TotalCount' => [ 'description' => 'The total number of entries.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], ], 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Param.Invalid', 'errorMessage' => 'Param invalid', ], [ 'errorCode' => 'Param.Invalid.TimeEndBeforeStart', 'errorMessage' => 'Param invalid. End time before start time', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'InvalidRequest', 'errorMessage' => 'Invalid Request.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Items\\": [\\n {\\n \\"Data\\": {\\n \\"CmsProduct\\": \\"web\\",\\n \\"DbType\\": \\"mysql\\",\\n \\"DetailImpact\\": \\"1\\",\\n \\"DetailReason\\": \\"xxxx\\",\\n \\"EndTime\\": \\"2023-03-06T11:46:01Z\\",\\n \\"EventCategory\\": \\"Exception\\",\\n \\"EventCode\\": \\"ENT000014\\",\\n \\"EventDetail\\": \\"xxxxx\\",\\n \\"EventId\\": \\"669036\\",\\n \\"EventImpact\\": \\"xxxxx\\",\\n \\"EventLevel\\": \\"INFO\\",\\n \\"EventReason\\": \\"xxxxx\\",\\n \\"EventStatus\\": \\"1\\",\\n \\"EventType\\": \\"StatusNotification\\",\\n \\"GmtCreated\\": \\"2023-03-17T16:05:40Z\\",\\n \\"GmtModified\\": \\"2022-12-14T09:44:39.000+0000\\",\\n \\"HandleStatus\\": \\"done\\",\\n \\"HasLifeCycle\\": 0,\\n \\"InstanceId\\": \\"rg-acfmy****\\",\\n \\"InstanceName\\": \\"dhimgsearch\\",\\n \\"IsClosed\\": 0,\\n \\"Product\\": \\"rds\\",\\n \\"RegionId\\": \\"cn-guangzhou\\",\\n \\"ResourceType\\": \\"Instance\\",\\n \\"SourceType\\": \\"MSE\\",\\n \\"StartTime\\": \\"2022-11-29T07:23Z\\",\\n \\"Uid\\": \\"16986832xxxxx\\"\\n },\\n \\"Id\\": \\"4309\\",\\n \\"Region\\": \\"cn-beijing\\",\\n \\"Source\\": \\"loanBill\\",\\n \\"Specversion\\": \\"8.0\\",\\n \\"Subject\\": \\"QiTian\\",\\n \\"Time\\": \\"1675232573125\\",\\n \\"Type\\": \\"host\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"RequestId\\": \\"7A41C147-C8D0-4DAE-A1A2-17EBCD60DFA1\\",\\n \\"TotalCount\\": 10\\n}","type":"json"}]', 'title' => 'DescribeHistoryEvents', ], 'ModifyEventInfo' => [ 'summary' => 'Modifies information about the events in the event center.', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the [DescribeRegions](~~610399~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'EventId', 'in' => 'query', 'schema' => [ 'title' => '事件ID，多个英文逗号分隔，最多支持20个', 'description' => 'The event ID. You can call the DescribeEvents operation to obtain the IDs of the events. Separate multiple event IDs with commas (,). You can specify up to 20 event IDs.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '5422964', ], ], [ 'name' => 'EventAction', 'in' => 'query', 'schema' => [ 'title' => '事件处理动作，目前支持archive和undo', 'description' => 'The event handling action. Valid values:'."\n" ."\n" .'* **archive**'."\n" .'* **undo**'."\n" ."\n" .'> This parameter is required.'."\n", 'type' => 'string', 'required' => false, 'example' => 'archive', ], ], [ 'name' => 'ActionParams', 'in' => 'query', 'schema' => [ 'title' => '动作参数，JSON String', 'description' => 'The action-related parameters. You can add action-related parameters based on your business requirements. The parameter value varies with the value of the TaskAction parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => '{\\"recoverTime\\":\\"2023-04-17T14:02:35Z\\",\\"recoverMode\\":\\"timePoint\\"}', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'ErrorCode' => [ 'description' => 'The error code.'."\n", 'type' => 'string', 'example' => 'mst.errorcode.success.errormessage', ], 'ErrorEventId' => [ 'description' => 'The error ID.'."\n", 'type' => 'string', 'example' => '12343', ], 'RequestId' => [ 'title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '224DB9F7-3100-4899-AB9C-C938BCCB43E7', ], 'SuccessCount' => [ 'description' => 'The number of successful records.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'SuccessEventId' => [ 'description' => 'The ID of the successful event.'."\n", 'type' => 'string', 'example' => '234221', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Param.Invalid', 'errorMessage' => 'Param.Invalid', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ErrorCode\\": \\"mst.errorcode.success.errormessage\\",\\n \\"ErrorEventId\\": \\"12343\\",\\n \\"RequestId\\": \\"224DB9F7-3100-4899-AB9C-C938BCCB43E7\\",\\n \\"SuccessCount\\": 1,\\n \\"SuccessEventId\\": \\"234221\\"\\n}","type":"json"}]', 'title' => 'ModifyEventInfo', ], 'DescribeHistoryTasksStat' => [ 'summary' => 'Collects tasks in the task center.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => [ 'description' => 'The region ID. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-beijing', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'The status of the task. Valid values:'."\n" ."\n" .'* **Scheduled**'."\n" .'* **Running**'."\n" .'* **Succeed**'."\n" .'* **Failed**'."\n" .'* **Cancelling**'."\n" .'* **Canceled**'."\n" .'* **Waiting**'."\n" ."\n" .'Separate multiple statuses with commas (,). By default, this parameter is left empty. This indicates that tasks in all statuses are queried.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Scheduled', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rm-2ze704f*****', ], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'description' => 'The task ID.'."\n", 'type' => 'string', 'required' => false, 'example' => '12221', ], ], [ 'name' => 'TaskType', 'in' => 'query', 'schema' => [ 'description' => 'The task type.'."\n", 'type' => 'string', 'required' => false, 'example' => 'all', ], ], [ 'name' => 'FromStartTime', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => [ 'description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the `yyyy-MM-ddTHH:mm:ssZ` format. The time must be in UTC.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2023-05-08T07:04:17Z', ], ], [ 'name' => 'ToStartTime', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => [ 'description' => 'The end of the time range to query. Only tasks that have a start time earlier than or equal to the time specified by this parameter are queried. Specify the time in the ISO 8601 standard in the `yyyy-MM-ddTHH:mm:ssZ` format. The time must be in UTC.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2023-02-24T10:01:37Z', ], ], [ 'name' => 'FromExecTime', 'in' => 'query', 'schema' => [ 'description' => 'The minimum execution duration of a task. This parameter is used to filter tasks whose execution duration is longer than the minimum execution duration. Unit: seconds. The default value is 0, which indicates that no limit is imposed.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], ], [ 'name' => 'ToExecTime', 'in' => 'query', 'schema' => [ 'description' => 'The maximum execution duration of a task. This parameter is used to filter tasks whose execution duration is shorter than or equal to the maximum execution duration. Unit: seconds. The default value is 0, which indicates that no limit is imposed.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy*****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'Items' => [ 'description' => 'The queried tasks.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the task.'."\n", 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => 'The status of the task. Valid values:'."\n" ."\n" .'* **Scheduled**'."\n" .'* **Running**'."\n" .'* **Succeed**'."\n" .'* **Failed**'."\n" .'* **Cancelling**'."\n" .'* **Canceled**'."\n" .'* **Waiting**'."\n", 'type' => 'string', 'example' => 'Succeed,Waiting', ], 'TotalCount' => [ 'description' => 'The total number of tasks.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], ], ], ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Param.Invalid', 'errorMessage' => 'Param invalid', ], [ 'errorCode' => 'Param.Invalid.TimeEndBeforeStart', 'errorMessage' => 'Param invalid. End time before start time', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'InvalidRequest', 'errorMessage' => 'Invalid Request.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Items\\": [\\n {\\n \\"Status\\": \\"Succeed,Waiting\\",\\n \\"TotalCount\\": 20\\n }\\n ],\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","type":"json"}]', 'title' => 'DescribeHistoryTasksStat', ], 'DescribeHistoryTasks' => [ 'summary' => 'Queries the historical tasks that are created within 30 days.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => [ 'description' => 'The region ID of the pending event. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-beijing', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page. Valid values: **10 to 100**. Default value: **10**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '10', 'example' => '10', 'default' => '10', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => 'The page number. Pages start from page 1. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'default' => '1', ], ], [ 'name' => 'InstanceType', 'in' => 'query', 'schema' => [ 'description' => 'Only Instance is supported.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Instance', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'The task status. Valid values:'."\n" ."\n" .'* **Scheduled**'."\n" .'* **Running**'."\n" .'* **Succeed**'."\n" .'* **Failed**'."\n" .'* **Cancelling**'."\n" .'* **Canceled**'."\n" .'* **Waiting**'."\n" ."\n" .'Separate multiple values with commas (,). By default, this parameter is left empty, which indicates that tasks in all statuses are queried.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Scheduled', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. Separate multiple instance IDs with commas (,). You can specify up to 30 instance IDs. This parameter is empty by default, which indicates that you can specify an unlimited number of instance IDs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rm-uf62br2491p5l****', ], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'description' => 'The task ID. You can call the DescribeTasks operation to query the task ID. If multiple task IDs exist, separate them with commas (,). You can specify up to 30 task IDs. By default, this parameter is left empty, which indicates that all tasks are queried.'."\n", 'type' => 'string', 'required' => false, 'example' => 't-83br18hloy3faf****'."\n", ], ], [ 'name' => 'TaskType', 'in' => 'query', 'schema' => [ 'description' => 'The task type. Separate multiple task types with commas (,). You can specify up to 30 task types. This parameter is empty by default, which indicates that you can specify an unlimited number of task types.'."\n", 'type' => 'string', 'required' => false, 'example' => 'autotest_dispatch_cases'."\n", ], ], [ 'name' => 'FromStartTime', 'in' => 'query', 'schema' => [ 'description' => 'The beginning of the time range to query. Only tasks that have a start time later than or equal to the time specified by this parameter are queried. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. The start time can be up to 30 days earlier than the current time. If you set this parameter to a time more than 30 days earlier than the current time, the specified time is automatically converted to a time that is exactly 30 days earlier than the current time.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2022-01-02T11:31:03Z', ], ], [ 'name' => 'ToStartTime', 'in' => 'query', 'schema' => [ 'description' => 'The end of the time range to query. Only tasks that have a start time earlier than or equal to the time specified by this parameter are queried. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2022-03-02T11:31:03Z', ], ], [ 'name' => 'FromExecTime', 'in' => 'query', 'schema' => [ 'description' => 'The minimum execution duration of the task. This parameter is used to filter tasks whose execution duration is longer than the minimum execution duration. Unit: seconds. The default value is 0, which indicates that no limit is imposed.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], ], [ 'name' => 'ToExecTime', 'in' => 'query', 'schema' => [ 'description' => 'The maximum execution duration of a task. This parameter is used to filter tasks whose execution duration is shorter than or equal to the maximum execution duration. Unit: seconds. The default value is 0, which indicates that no limit is imposed.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-aekzbvctytru7ua', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'Items' => [ 'description' => 'The tasks.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The task object.'."\n", 'type' => 'object', 'properties' => [ 'ActionInfo' => [ 'description' => 'A set of allowed actions that can be taken on the task. The system matches the current step name and status of the task to the available actions specified by ActionInfo. If no matching action is found, the current status of the task does not support any action. Example:'."\n" ."\n" .' "steps": ['."\n" .' {'."\n" .' "step_name": "exec_task", // The name of the step, which matches CurrentStepName. "action_info": { // The actions supported for this step. "Waiting": [ // The status, which matches Status. "modifySwitchTime" // The action. Multiple actions are supported. ]'."\n" .' }'."\n" .' },'."\n" .' {'."\n" .' "step_name": "init_task", // The name of the step. "action_info": { // The actions supported for this step. "Running": [ // The status. "cancel", // The action. "pause"'."\n" .' ]'."\n" .' }'."\n" .' }'."\n" .' ]'."\n" .' }'."\n" ."\n" .'The system may support the following actions:'."\n" ."\n" .'* **retry**: retries the action.'."\n" .'* **cancel**: cancels the action.'."\n" .'* **modifySwitchTime**: changes the switching time or restoration time.'."\n", 'type' => 'string', 'example' => '{\\"steps\\":[{\\"action_info\\":{\\"Waiting\\":[\\"modifySwitchTime\\"]},\\"step_name\\":\\"exec_task\\"}]}', ], 'CallerSource' => [ 'description' => 'The ID of the user who made the request. If CallerSource is set to User, CallerUid indicates the unique ID (UID) of the user.'."\n", 'type' => 'string', 'example' => '141345906006****', ], 'CallerUid' => [ 'description' => 'The source of the request. Valid values:'."\n" ."\n" .'* **System**'."\n" .'* **User**'."\n", 'type' => 'string', 'example' => 'User', ], 'CurrentStepName' => [ 'description' => 'The name of the current step. If this parameter is left empty, the task is not started.'."\n", 'type' => 'string', 'example' => 'exec_task', ], 'DbType' => [ 'description' => 'The database type.'."\n", 'type' => 'string', 'example' => 'mysql', ], 'EndTime' => [ 'description' => 'The end time of the task.'."\n", 'type' => 'string', 'example' => '2022-02-03T12:06:17Z', ], 'InstanceId' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-uf62br2491p5l****', ], 'InstanceName' => [ 'description' => 'The instance name.'."\n", 'type' => 'string', 'example' => 'test', ], 'InstanceType' => [ 'description' => 'The instance category.'."\n", 'type' => 'string', 'example' => 'Instance', ], 'Product' => [ 'description' => 'The service name.'."\n", 'type' => 'string', 'example' => 'rds', ], 'Progress' => [ 'description' => 'Indicates the task progress.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '79.0', ], 'ReasonCode' => [ 'description' => 'The reason why the current task was initiated.'."\n", 'type' => 'string', 'example' => ' ****', ], 'RegionId' => [ 'description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-shanghai', ], 'RemainTime' => [ 'description' => 'The estimated amount of time remaining to complete the task. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1000', ], 'StartTime' => [ 'description' => 'The start time of the task.'."\n", 'type' => 'string', 'example' => '2022-02-03T11:31:03Z', ], 'Status' => [ 'description' => 'The task status. Valid values:'."\n" ."\n" .'* Scheduled'."\n" .'* Running'."\n" .'* Succeed'."\n" .'* Failed'."\n" .'* Cancelling'."\n" .'* Canceled'."\n" .'* Waiting'."\n", 'type' => 'string', 'example' => 'Running', ], 'TaskDetail' => [ 'description' => 'The task details.'."\n", 'type' => 'string', 'example' => '{\\"callerUid\\":\\"test\\"}', ], 'TaskId' => [ 'description' => 'The task ID.'."\n", 'type' => 'string', 'example' => 't-83br18hloy3faf****', ], 'TaskType' => [ 'description' => 'The task type.'."\n", 'type' => 'string', 'example' => 'autotest_dispatch_cases', ], 'Uid' => [ 'description' => 'The ID of the user to which the resources belong.'."\n", 'type' => 'string', 'example' => '141345906006****', ], ], ], ], 'PageNumber' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'RequestId' => [ 'description' => 'The unique ID of the request. If the request fails, provide this ID for technical support to troubleshoot the failure.'."\n", 'type' => 'string', 'example' => '5CD61041-35F7-10F7-BE94-33A48B22****', ], 'TotalCount' => [ 'description' => 'The total number of tasks that meet these constraints without taking pagination into account.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Param.Invalid', 'errorMessage' => 'Param invalid', ], [ 'errorCode' => 'Param.Invalid.TimeEndBeforeStart', 'errorMessage' => 'Param invalid. End time before start time', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'InvalidRequest', 'errorMessage' => 'Invalid Request.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Items\\": [\\n {\\n \\"ActionInfo\\": \\"{\\\\\\\\\\\\\\"steps\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"action_info\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Waiting\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"modifySwitchTime\\\\\\\\\\\\\\"]},\\\\\\\\\\\\\\"step_name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"exec_task\\\\\\\\\\\\\\"}]}\\",\\n \\"CallerSource\\": \\"141345906006****\\",\\n \\"CallerUid\\": \\"User\\",\\n \\"CurrentStepName\\": \\"exec_task\\",\\n \\"DbType\\": \\"mysql\\",\\n \\"EndTime\\": \\"2022-02-03T12:06:17Z\\",\\n \\"InstanceId\\": \\"rm-uf62br2491p5l****\\",\\n \\"InstanceName\\": \\"test\\",\\n \\"InstanceType\\": \\"Instance\\",\\n \\"Product\\": \\"rds\\",\\n \\"Progress\\": 79,\\n \\"ReasonCode\\": \\" ****\\",\\n \\"RegionId\\": \\"cn-shanghai\\",\\n \\"RemainTime\\": 1000,\\n \\"StartTime\\": \\"2022-02-03T11:31:03Z\\",\\n \\"Status\\": \\"Running\\",\\n \\"TaskDetail\\": \\"{\\\\\\\\\\\\\\"callerUid\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"test\\\\\\\\\\\\\\"}\\",\\n \\"TaskId\\": \\"t-83br18hloy3faf****\\",\\n \\"TaskType\\": \\"autotest_dispatch_cases\\",\\n \\"Uid\\": \\"141345906006****\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"5CD61041-35F7-10F7-BE94-33A48B22****\\",\\n \\"TotalCount\\": 2\\n}","type":"json"}]', 'title' => 'DescribeHistoryTasks', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* MySQL'."\n" .'* PostgreSQL'."\n" .'* SQL Server'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> : Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.'."\n" ."\n" .'* [Tasks of an ApsaraDB RDS for MySQL instance](~~474275~~)'."\n" .'* [Tasks of an ApsaraDB RDS for PostrgreSQL instance](~~474537~~)'."\n" .'* [Tasks of an ApsaraDB RDS for SQL Server instance](~~614826~~)'."\n", ], 'ModifyTaskInfo' => [ 'summary' => 'Modifies information about the historical tasks in the task center.', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the [DescribeRegions](~~26243~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'description' => 'The task ID. You can call the DescribeTasks operation to query task IDs.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 't-83br18hloum8u3948s', ], ], [ 'name' => 'StepName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the execution step.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ha_switch', ], ], [ 'name' => 'TaskAction', 'in' => 'query', 'schema' => [ 'description' => 'The task action. Set the value to modifySwitchTime. The value specifies that you want to change the switching time or restoration time.'."\n", 'type' => 'string', 'required' => false, 'enumValueTitles' => [], 'example' => 'ImportImage', ], ], [ 'name' => 'ActionParams', 'in' => 'query', 'schema' => [ 'description' => 'The action-related parameters. You can add action-related parameters based on your business requirements. If you set the TaskAction parameter to modifySwitchTime, you must set this parameter to `{"recoverMode": "xxx", "recoverTime": "xxx"}`.'."\n" ."\n" .'The recoverMode field specifies the task restoration mode. valid values:'."\n" ."\n" .'* **timePoint**: The task is executed at a specified point in time.'."\n" .'* **Immediate**: The task is executed immediately.'."\n" .'* **maintainTime**: The task is executed based on the O\\&M time.'."\n" ."\n" .'The recoverTime field specifies restoration time. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. If you set the recoverMode field to timePoint, you must also specify the recoverTime field.'."\n", 'type' => 'string', 'required' => false, 'example' => '{\\"recoverTime\\":\\"2023-04-12T18:30:00Z\\",\\"recoverMode\\":\\"timePoint\\"}', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'ErrorCode' => [ 'description' => 'The error code.'."\n", 'type' => 'string', 'example' => 'mst.errorcode.success.errormessage', ], 'ErrorTaskId' => [ 'description' => 'The ID of the failed task. This parameter is returned when a task fails.'."\n", 'type' => 'string', 'example' => 't-83br18hlw11ue610yo', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '18B3000C-2B06-5D4F-AA5B-456D5FBCA55B', ], 'SuccessCount' => [ 'description' => 'The number of completed tasks.'."\n", 'type' => 'string', 'example' => '5', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Param.Invalid', 'errorMessage' => 'Param invalid', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ErrorCode\\": \\"mst.errorcode.success.errormessage\\",\\n \\"ErrorTaskId\\": \\"t-83br18hlw11ue610yo\\",\\n \\"RequestId\\": \\"18B3000C-2B06-5D4F-AA5B-456D5FBCA55B\\",\\n \\"SuccessCount\\": \\"5\\"\\n}","type":"json"}]', 'title' => 'ModifyTaskInfo', ], 'DescribeTasks' => [ 'summary' => 'Queries the tasks in the Waiting or Executing state on an ApsaraDB RDS for SQL Server instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5xxxxxxxxxx', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => false, 'example' => '2020-11-20T01:00Z', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => 'The end of the time range to query. The end time must be later than the start time. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => false, 'example' => '2020-11-20T02:00Z', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return per page. Valid values: **30 to 100**. Default value: **30**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '30', 'example' => '30', 'default' => '30', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => 'The page number. Pages start from page 1. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'default' => '1', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'The status of the task. This parameter is invalid.'."\n", 'type' => 'string', 'required' => false, 'example' => '2', ], ], [ 'name' => 'TaskAction', 'in' => 'query', 'schema' => [ 'description' => 'The operation that is used by the task.'."\n", 'type' => 'string', 'required' => false, 'example' => 'CreateInstance', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Items' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'TaskProgressInfo' => [ 'description' => 'The details of the task execution.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'BeginTime' => [ 'description' => 'The start time of the task. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm*Z format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2020-11-20T01:00Z', ], 'CurrentStepName' => [ 'description' => 'The name of the subtask.'."\n", 'type' => 'string', 'example' => 'create_instance', ], 'DBName' => [ 'description' => 'The name of the database. If the task involves a database, the database name is returned.'."\n", 'type' => 'string', 'example' => 'DBtest', ], 'ExpectedFinishTime' => [ 'description' => 'The estimated end time of the task.'."\n" ."\n" .'> In most cases, this parameter is empty.'."\n", 'type' => 'string', 'example' => 'null', ], 'FinishTime' => [ 'description' => 'The end time of the task. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm*Z format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2020-11-20T02:00Z', ], 'Progress' => [ 'description' => 'The task progress in percentage.'."\n", 'type' => 'string', 'example' => '100', ], 'ProgressInfo' => [ 'description' => 'The description of the task progress.'."\n" ."\n" .'> If no progress description is provided for the task, this parameter is empty.'."\n", 'type' => 'string', 'example' => 'null', ], 'Remain' => [ 'description' => 'The estimated remaining time of the task. Unit: seconds.'."\n" ."\n" .'> If the task is not running, this parameter is not returned or the returned value is **0**.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '60', ], 'Status' => [ 'description' => 'The status of the task.'."\n", 'type' => 'string', 'example' => '2', ], 'StepProgressInfo' => [ 'description' => 'The progress of the subtask. For example, a value of `1/4` indicates that the task consists of four subtasks and the first subtask is in progress.'."\n", 'type' => 'string', 'example' => '1/4', ], 'StepsInfo' => [ 'description' => 'The details of the subtasks.'."\n", 'type' => 'string', 'example' => 'null', ], 'TaskAction' => [ 'description' => 'The operation that is used by the task, such as **CreateDBInstance**.'."\n", 'type' => 'string', 'example' => 'CreateDBInstance', ], 'TaskErrorCode' => [ 'description' => 'The error code that is returned when an error occurs.'."\n" ."\n" .'> This parameter is returned only when an error occurs.'."\n", 'type' => 'string', 'example' => 'null', ], 'TaskErrorMessage' => [ 'description' => 'The error message that is returned when an error occurs.'."\n" ."\n" .'> This parameter is returned only when an error occurs.'."\n", 'type' => 'string', 'example' => 'null', ], 'TaskId' => [ 'description' => 'The task ID. You can use one of the following methods to obtain the task ID:'."\n", 'type' => 'string', 'example' => '3472xxxxx', ], ], 'description' => '', ], ], ], ], 'PageNumber' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageRecordCount' => [ 'description' => 'The number of entries on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'A103039D-B1B2-4C57-B989-7D7C0DA95426', ], 'TotalRecordCount' => [ 'description' => 'The total number of entries.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '40', ], ], 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'IO.Exception', 'errorMessage' => 'IO exception, retry later.', ], [ 'errorCode' => 'InvokeServiceFailed', 'errorMessage' => 'Invoke service failed, retry later.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Items\\": {\\n \\"TaskProgressInfo\\": [\\n {\\n \\"BeginTime\\": \\"2020-11-20T01:00Z\\",\\n \\"CurrentStepName\\": \\"create_instance\\",\\n \\"DBName\\": \\"DBtest\\",\\n \\"ExpectedFinishTime\\": \\"null\\",\\n \\"FinishTime\\": \\"2020-11-20T02:00Z\\",\\n \\"Progress\\": \\"100\\",\\n \\"ProgressInfo\\": \\"null\\",\\n \\"Remain\\": 60,\\n \\"Status\\": \\"2\\",\\n \\"StepProgressInfo\\": \\"1/4\\",\\n \\"StepsInfo\\": \\"null\\",\\n \\"TaskAction\\": \\"CreateDBInstance\\",\\n \\"TaskErrorCode\\": \\"null\\",\\n \\"TaskErrorMessage\\": \\"null\\",\\n \\"TaskId\\": \\"3472xxxxx\\"\\n }\\n ]\\n },\\n \\"PageNumber\\": 1,\\n \\"PageRecordCount\\": 30,\\n \\"RequestId\\": \\"A103039D-B1B2-4C57-B989-7D7C0DA95426\\",\\n \\"TotalRecordCount\\": 40\\n}","errorExample":""},{"type":"xml","example":"40\\n30\\nA103039D-B1B2-4C57-B989-7D7C0DA95426\\n1\\n\\n \\n 2\\n null\\n 100\\n 60\\n 3472xxxxx\\n CreateDBInstance\\n 2020-11-20T01:00Z\\n null\\n 1/4\\n 2020-11-20T02:00Z\\n create_instance\\n null\\n null\\n DBtest\\n null\\n \\n","errorExample":""}]', 'title' => 'DescribeTasks', 'description' => '### [](#)Supported database engine'."\n" ."\n" .'SQL Server'."\n" ."\n" .'> You can call the [DescribeHistoryTasks](~~2627863~~) operation to query the tasks on an ApsaraDB RDS for MySQL or ApsaraDB RDS for PostgreSQL instance'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'CreateYouhuiForOrder' => [ 'summary' => '下单领券接口', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', ], 'parameters' => [ [ 'name' => 'ActivityId', 'in' => 'query', 'schema' => [ 'description' => 'The activity ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1711510887******', ], ], [ 'name' => 'PromotionId', 'in' => 'query', 'schema' => [ 'description' => 'The promotion ID. You can call the GetResourcePrice operation to query the promotion ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2000001******', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => [ 'description' => 'The response parameters.'."\n", 'type' => 'string', 'example' => 'Successful', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0688F1D2-CDA8-5617-A43C-ADAC61D80D43', ], 'YouhuiId' => [ 'description' => 'The coupon ID.'."\n", 'type' => 'string', 'example' => '221201******', ], ], 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'YouhuiClientError', 'errorMessage' => 'Calling service from youhui service error', ], [ 'errorCode' => 'CouponExist', 'errorMessage' => 'Voucher collection has reached the upper limit, and the system has recalculated the optimal price.', ], [ 'errorCode' => 'YouhuiServerError', 'errorMessage' => 'Calling service from youhui service errror', ], [ 'errorCode' => 'CreateCouponError', 'errorMessage' => 'Failed to collect the coupon and place the order. The system has recalculated the optimal price.', ], [ 'errorCode' => 'CouponOverMaxRelease', 'errorMessage' => 'The coupons have been collected and the system has recalculated the optimal price.', ], [ 'errorCode' => 'MissingActivityId', 'errorMessage' => 'ActivityId is mandatory for this action.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'ParamError', 'errorMessage' => 'Parameter error.', ], [ 'errorCode' => 'ActivityNotFound', 'errorMessage' => 'The activity does not exist.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"0688F1D2-CDA8-5617-A43C-ADAC61D80D43\\",\\n \\"YouhuiId\\": \\"22120151****\\"\\n}","type":"json"}]', 'title' => 'CreateYouhuiForOrder', ], 'DescribeCurrentModifyOrder' => [ 'summary' => '查询实例最新变配订单', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the generated token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxxxxx', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'DbInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-bp1u775467ggm7j9j', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy*****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'ModifyOrder' => [ 'description' => 'The specification change order.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ClassGroup' => [ 'description' => 'The instance family of the instance.'."\n", 'type' => 'string', 'example' => 'x', ], 'Cpu' => [ 'description' => 'The number of CPU cores that are supported by the instance type. Unit: cores.'."\n", 'type' => 'string', 'example' => '8', ], 'DbInstanceId' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-cn-nwy39qeys0003r', ], 'EffectiveTime' => [ 'description' => 'The effective time. Valid values:'."\n" ."\n" .'* **Immediate**: This is the default value.'."\n" .'* **MaintainTime**: The effective time is within the maintenance window. For more information, see [ModifyDBInstanceMaintainTime](~~610402~~).'."\n", 'type' => 'string', 'example' => 'MaintainTime', ], 'Mark' => [ 'description' => 'The description of the instance.'."\n", 'type' => 'string', 'example' => 'eyJ2IjoibWV0YS5rOHMuaW8vdjEiLCJydiI6MTg2MjEwOTkwLCJzdGFydCI6InNob3BpZnktdXNlci1jb3JlXHUwMDAwIn0', ], 'MemoryClass' => [ 'description' => 'The memory capacity that is supported by the instance type. Unit: GB.'."\n", 'type' => 'string', 'example' => '1024', ], 'Status' => [ 'description' => 'The status of the task.'."\n", 'type' => 'string', 'example' => 'Succeed,Scheduled,Running,Cancelling,Canceled,Waiting', ], 'Storage' => [ 'description' => 'The storage capacity of the instance.'."\n", 'type' => 'string', 'example' => '20', ], 'TargetDBInstanceClass' => [ 'description' => 'The new instance type of the instance. Valid values:'."\n", 'type' => 'string', 'example' => 'mysql.x2.medium.2c', ], ], ], ], 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'C87415BE-F5AB-55A4-A60E-A0A329EAF2A4', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidOrderId.NotFound', 'errorMessage' => 'Specified order does not exist in RDS.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ModifyOrder\\": [\\n {\\n \\"ClassGroup\\": \\"x\\",\\n \\"Cpu\\": \\"8\\",\\n \\"DbInstanceId\\": \\"rm-cn-nwy39qeys0003r\\",\\n \\"EffectiveTime\\": \\"MaintainTime\\",\\n \\"Mark\\": \\"无\\",\\n \\"MemoryClass\\": \\"1024\\",\\n \\"Status\\": \\"Succeed,Scheduled,Running,Cancelling,Canceled,Waiting\\",\\n \\"Storage\\": \\"20\\",\\n \\"TargetDBInstanceClass\\": \\"mysql.x2.medium.2c\\"\\n }\\n ],\\n \\"RequestId\\": \\"C87415BE-F5AB-55A4-A60E-A0A329EAF2A4\\"\\n}","type":"json"}]', 'title' => 'DescribeCurrentModifyOrder', ], 'DescribeCustinsResourceInfo' => [ 'summary' => '查询实例资源使用情况', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DBInstanceIds', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the [DescribeDBInstances](~~26232~~) operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-wz9s06u4drmqj4aqv', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy*****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The returned data.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'CpuAdjustDeadline' => [ 'description' => 'The deadline for the CPU adjustment.'."\n", 'type' => 'string', 'example' => '2023-10-25', ], 'CpuAdjustableMaxRatio' => [ 'description' => 'The maximum percentage of the system CPU resources that the instance can use.'."\n", 'type' => 'string', 'example' => '30', ], 'CpuAdjustableMaxValue' => [ 'description' => 'The maximum CPU utilization.'."\n", 'type' => 'string', 'example' => '60', ], 'CpuIncreaseRatio' => [ 'description' => 'The CPU utilization.'."\n", 'type' => 'string', 'example' => '10', ], 'CpuIncreaseRatioValue' => [ 'description' => 'The CPU utilization. Unit: percentage.'."\n", 'type' => 'string', 'example' => '20', ], 'DBInstanceId' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-wz92gn1ll9fe5d3a4', ], 'IopsAdjustableMaxValue' => [ 'description' => 'The maximum IOPS.'."\n", 'type' => 'string', 'example' => '20', ], 'MaxConnAdjustDeadline' => [ 'description' => 'The deadline for the adjustment of the maximum number of connections.'."\n", 'type' => 'string', 'example' => '2023-10-25'."\n", ], 'MaxConnAdjustableMaxValue' => [ 'description' => 'The maximum number of concurrent connections.'."\n", 'type' => 'string', 'example' => '100', ], 'MaxConnIncreaseRatio' => [ 'description' => 'The maximum number of concurrent connections.'."\n", 'type' => 'string', 'example' => '100', ], 'MaxConnIncreaseRatioValue' => [ 'description' => 'The maximum number of concurrent connections.'."\n", 'type' => 'string', 'example' => '20', ], 'MaxIopsAdjustDeadline' => [ 'description' => 'The deadline for the adjustment of the maximum IOPS.'."\n", 'type' => 'string', 'example' => '2023-10-25'."\n", ], 'MaxIopsIncreaseRatio' => [ 'description' => 'The maximum IOPS.'."\n", 'type' => 'string', 'example' => '100', ], 'MaxIopsIncreaseRatioValue' => [ 'description' => 'The maximum IOPS that can be supported by the instance.'."\n", 'type' => 'string', 'example' => '20', ], 'MemAdjustableMaxRatio' => [ 'description' => 'The maximum percentage of the system memory that the instance can use.'."\n", 'type' => 'string', 'example' => '60', ], 'MemAdjustableMaxValue' => [ 'description' => 'The maximum value of the resources to be evaluated.'."\n", 'type' => 'string', 'example' => '200', ], 'MemoryAdjustDeadline' => [ 'description' => 'The deadline for the memory adjustment.'."\n", 'type' => 'string', 'example' => '2023-10-25', ], 'MemoryIncreaseRatio' => [ 'description' => 'The memory increase percentage.'."\n", 'type' => 'string', 'enumValueTitles' => [], 'example' => '2023-10-25', ], 'MemoryIncreaseRatioValue' => [ 'description' => 'The memory usage. Unit: MB.'."\n", 'type' => 'string', 'example' => '200', ], 'OriginCpu' => [ 'description' => 'The number of CPUs of the instance.'."\n", 'type' => 'string', 'example' => '2', ], 'OriginMaxConn' => [ 'description' => 'The maximum number of concurrent connections.'."\n", 'type' => 'string', 'example' => '30', ], 'OriginMaxIops' => [ 'description' => 'The maximum IOPS.'."\n", 'type' => 'string', 'example' => '20', ], 'OriginMemory' => [ 'description' => 'The actual memory used. Unit: MB.'."\n", 'type' => 'string', 'example' => '20', ], ], ], ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'D4D4BE8A-DD46-440A-BFCD-EE31DA81C9DD', ], ], 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidCPUZoom.NotSupport', 'errorMessage' => 'The param cpuZoom not in valid range', ], [ 'errorCode' => 'InvalidCPUShar.NotSupport', 'errorMessage' => 'The param cpuShar not in valid range', ], [ 'errorCode' => 'InvalidMemoryZoom.NotSupport', 'errorMessage' => 'The param memory zoom not in valid range', ], [ 'errorCode' => 'InvalidIOPSZoom.NotSupport', 'errorMessage' => 'The param iops zoom not in valid range', ], [ 'errorCode' => 'InvalidMaxConnZoom.NotSupport', 'errorMessage' => 'The param MaxConne zoom not in valid range', ], [ 'errorCode' => 'InvalidResource.Type.NotSupport', 'errorMessage' => 'The param Resource Type not in valid range', ], [ 'errorCode' => 'InvalidIncreaseRatio.Type.NotSupport', 'errorMessage' => 'Insufficient host resources, please reduce the ratio', ], [ 'errorCode' => 'InvalidDedicatedHostGroupName', 'errorMessage' => 'The DedicatedHostGroupName is invalid', ], [ 'errorCode' => 'InvalidInsName', 'errorMessage' => 'The InsName is invalid', ], [ 'errorCode' => 'ClusterTypeError', 'errorMessage' => 'The Custins cluster type encounters an error. Standard cluster is not supported.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'ClusterTypeError', 'errorMessage' => 'Custins Cluster Type Error, Support User Cluster', ], [ 'errorCode' => 'DedicatedHostNameIsNull', 'errorMessage' => 'Dedicated Host Name Is Null!', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'PhysicalCustins.NotFound', 'errorMessage' => 'Physical Custins Not Found!', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'Current cluster not found host info!', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"CpuAdjustDeadline\\": \\"2023-10-25\\",\\n \\"CpuAdjustableMaxRatio\\": \\"30\\",\\n \\"CpuAdjustableMaxValue\\": \\"60\\",\\n \\"CpuIncreaseRatio\\": \\"10\\",\\n \\"CpuIncreaseRatioValue\\": \\"20\\",\\n \\"DBInstanceId\\": \\" rm-wz9s06u4drm******\\",\\n \\"IopsAdjustableMaxValue\\": \\"20\\",\\n \\"MaxConnAdjustDeadline\\": \\"2023-10-25\\\\n\\",\\n \\"MaxConnAdjustableMaxValue\\": \\"100\\",\\n \\"MaxConnIncreaseRatio\\": \\"100\\",\\n \\"MaxConnIncreaseRatioValue\\": \\"20\\",\\n \\"MaxIopsAdjustDeadline\\": \\"2023-10-25\\\\n\\",\\n \\"MaxIopsIncreaseRatio\\": \\"100\\",\\n \\"MaxIopsIncreaseRatioValue\\": \\"20\\",\\n \\"MemAdjustableMaxRatio\\": \\"60\\",\\n \\"MemAdjustableMaxValue\\": \\"200\\",\\n \\"MemoryAdjustDeadline\\": \\"2023-10-25\\",\\n \\"MemoryIncreaseRatio\\": \\"20\\",\\n \\"MemoryIncreaseRatioValue\\": \\"200\\",\\n \\"OriginCpu\\": \\"2\\",\\n \\"OriginMaxConn\\": \\"30\\",\\n \\"OriginMaxIops\\": \\"20\\",\\n \\"OriginMemory\\": \\"20\\"\\n }\\n ],\\n \\"RequestId\\": \\"D4D4BE8A-DD46-440A-BFCD-EE31DA81C9DD\\"\\n}","type":"json"}]', 'title' => 'DescribeCustinsResourceInfo', ], 'DescribeDBInstanceConnectivity' => [ 'summary' => '获取实例链路诊断信息', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy****', ], ], [ 'name' => 'DbInstanceName', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-t4ns09hgoy99i5gez', ], ], [ 'name' => 'SourceIpAddress', 'in' => 'query', 'schema' => [ 'description' => 'The source IP address.'."\n", 'type' => 'string', 'required' => true, 'example' => '172.16.XX.XX', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'ConnCheckErrorCode' => [ 'description' => 'The error code for connection diagnosis. Valid values:'."\n" ."\n" .'* **SRC_IP_NOT_IN_USER_WHITELIST**: The source IP address is not added to the whitelist.'."\n" .'* **CONNECTION_ABNORMAL**: The connection to the cluster is normal.'."\n", 'type' => 'string', 'example' => 'SRC_IP_NOT_IN_USER_WHITELIST', ], 'ConnCheckErrorMessage' => [ 'description' => 'The error message for connection diagnosis.'."\n", 'type' => 'string', 'example' => 'Src ip:39.106.64.59 not in user whitelist', ], 'ConnCheckResult' => [ 'description' => 'The connection diagnosis result. Valid values:'."\n" ."\n" .'* **Success**'."\n" .'* **Failed**'."\n", 'type' => 'string', 'example' => 'Failed', ], 'DbInstanceName' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-2ze2za3is7baay1w4', ], 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'D880212A-F21F-5722-8422-BD06B2874CC3', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Connect.Timeout', 'errorMessage' => 'Check connectivity timeout', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ConnCheckErrorCode\\": \\"SRC_IP_NOT_IN_USER_WHITELIST\\",\\n \\"ConnCheckErrorMessage\\": \\"Src ip:39.106.64.59 not in user whitelist\\",\\n \\"ConnCheckResult\\": \\"Failed\\",\\n \\"DbInstanceName\\": \\"rm-2ze2za3is7baay1w4\\",\\n \\"RequestId\\": \\"D880212A-F21F-5722-8422-BD06B2874CC3\\"\\n}","type":"json"}]', 'title' => 'DescribeDBInstanceConnectivity', ], 'DescribeHostGroupElasticStrategyParameters' => [ 'summary' => '查询主机组弹性策略参数', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the [DescribeRegions](~~26243~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shanghai', ], ], [ 'name' => 'DedicatedHostGroupName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the dedicated cluster.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dhg-d0dwi82293b2w9t5', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'CpuShar' => [ 'description' => 'The CPU utilization of the instance. Unit: percentage.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'CpuZoom' => [ 'description' => 'The number of CPU cores used by the instance. Unit: cores.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '4', ], 'IopsZoom' => [ 'description' => 'The number of I/O requests.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'MaxConnZoom' => [ 'description' => 'The maximum number of concurrent connections supported by the instance type.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', ], 'MemoryZoom' => [ 'description' => 'The total memory size of the instance in the dedicated cluster. Unit: MB.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1000', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '60F9A12A-16B8-4728-B099-4CA38D32C31C', ], ], 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidCPUZoom.NotSupport', 'errorMessage' => 'The param cpuZoom not in valid range', ], [ 'errorCode' => 'InvalidCPUShar.NotSupport', 'errorMessage' => 'The param cpuShar not in valid range', ], [ 'errorCode' => 'InvalidMemoryZoom.NotSupport', 'errorMessage' => 'The param memory zoom not in valid range', ], [ 'errorCode' => 'InvalidIOPSZoom.NotSupport', 'errorMessage' => 'The param iops zoom not in valid range', ], [ 'errorCode' => 'InvalidMaxConnZoom.NotSupport', 'errorMessage' => 'The param MaxConne zoom not in valid range', ], [ 'errorCode' => 'InvalidResource.Type.NotSupport', 'errorMessage' => 'The param Resource Type not in valid range', ], [ 'errorCode' => 'InvalidIncreaseRatio.Type.NotSupport', 'errorMessage' => 'Insufficient host resources, please reduce the ratio', ], [ 'errorCode' => 'InvalidDedicatedHostGroupName', 'errorMessage' => 'The DedicatedHostGroupName is invalid', ], [ 'errorCode' => 'InvalidInsName', 'errorMessage' => 'The InsName is invalid', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'InvalidUserId.NotSupport', 'errorMessage' => 'The user ID has no permission.', ], ], 403 => [ [ 'errorCode' => 'ClusterTypeError', 'errorMessage' => 'Custins Cluster Type Error, Support User Cluster', ], [ 'errorCode' => 'DedicatedHostNameIsNull', 'errorMessage' => 'Dedicated Host Name Is Null!', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDedicatedHostGroupName', 'errorMessage' => 'Physical Custins Not Found!', ], [ 'errorCode' => 'HostInfo.NotFound ', 'errorMessage' => 'Current cluster not found host info!', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CpuShar\\": 20,\\n \\"CpuZoom\\": 4,\\n \\"IopsZoom\\": 10,\\n \\"MaxConnZoom\\": 30,\\n \\"MemoryZoom\\": 1000,\\n \\"RequestId\\": \\"60F9A12A-16B8-4728-B099-4CA38D32C31C\\"\\n}","type":"json"}]', 'title' => 'DescribeHostGroupElasticStrategyParameters', ], 'DescribeMarketingActivity' => [ 'summary' => '获取RDS营销项目中待升级实例信息', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the [DescribeRegions](~~26243~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'Bid', 'in' => 'query', 'schema' => [ 'description' => '* China site: 26842'."\n" .'* International site: 26888'."\n", 'type' => 'string', 'required' => false, 'example' => '26842', ], ], [ 'name' => 'UpgradeCode', 'in' => 'query', 'schema' => [ 'description' => 'The service name.'."\n", 'type' => 'string', 'required' => true, 'example' => 'series', ], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxx', ], ], [ 'name' => 'AliUid', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the Alibaba Cloud account.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9999999999999999', 'minimum' => '0', 'example' => '20725049', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy*****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'AliUid' => [ 'description' => 'The ID of the Alibaba Cloud account.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1979008652307170', ], 'Bid' => [ 'description' => '* China site: 26842'."\n" .'* International site: 26888'."\n", 'type' => 'string', 'example' => '26842', ], 'Items' => [ 'description' => 'The activity parameters'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Category' => [ 'description' => 'The RDS edition of the instance. Valid values:'."\n" ."\n" .'* **Basic**: RDS Basic Edition'."\n" .'* **HighAvailability**: RDS High-availability Edition'."\n" .'* **AlwaysOn**: RDS Cluster Edition'."\n" .'* **Finance**: RDS Enterprise Edition'."\n", 'type' => 'string', 'example' => 'Basic', ], 'ChargeType' => [ 'description' => 'The payment type. Valid values:'."\n" ."\n" .'* POSTPAY: pay-as-you-go'."\n" .'* PREPAY: subscription'."\n", 'type' => 'string', 'example' => 'POSTPAY', ], 'ClassCode' => [ 'description' => 'The instance type. For more information, see [Primary ApsaraDB RDS instance types](~~26312~~) and [Read-only ApsaraDB RDS instance types](~~145759~~).'."\n", 'type' => 'string', 'example' => 'rds.mysql.s3.large', ], 'ClassGroup' => [ 'description' => 'The instance family. For more information, see [Overview of instance families](~~57184~~).'."\n", 'type' => 'string', 'example' => 'x', ], 'Cpu' => [ 'description' => 'The number of CPU cores that are supported by the instance type. Unit: cores.'."\n", 'type' => 'string', 'example' => '2', ], 'DiskSize' => [ 'description' => 'The disk capacity per node. Unit: GB.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '900', ], 'Engine' => [ 'description' => 'The database engine of the instance. Valid values:'."\n" ."\n" .'* MySQL'."\n" .'* SQLServer'."\n" .'* PostgreSQL'."\n" .'* PPAS'."\n" .'* MariaDB'."\n", 'type' => 'string', 'example' => 'MySQL', ], 'EngineVersion' => [ 'description' => 'The version of the database engine.'."\n", 'type' => 'string', 'example' => '8.0', ], 'InstanceId' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-uf62br2491p5l****', ], 'InstanceName' => [ 'description' => 'The instance name.'."\n", 'type' => 'string', 'example' => 'rm-uf62br2491p5l****', ], 'MaxConnections' => [ 'description' => 'The maximum number of concurrent connections.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '60', ], 'MaxIombps' => [ 'description' => 'The maximum I/O throughput. Unit: Mbit/s.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'MaxIops' => [ 'description' => 'The maximum IOPS.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', ], 'Memory' => [ 'description' => 'The memory size.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1024', ], 'StorageType' => [ 'description' => 'The storage type of the instance. Valid values:'."\n" ."\n" .'* **local_ssd**: local SSD'."\n" .'* **cloud_ssd**: standard SSD'."\n" .'* **cloud_essd**: performance level 1 (PL1) enhanced SSD (ESSD)'."\n" .'* **cloud_essd2**: PL2 ESSD'."\n" .'* **cloud_essd3**: PL3 ESSD'."\n", 'type' => 'string', 'example' => 'cloud_essd', ], 'UpgradeCategory' => [ 'description' => 'The RDS edition after the upgrade.'."\n", 'type' => 'string', 'example' => 'HighAvailability', ], 'UpgradeClassCode' => [ 'description' => 'The instance type after the upgrade.'."\n", 'type' => 'string', 'example' => 'rds.mysql.s3.large', ], 'UpgradeClassGroup' => [ 'description' => 'The instance family after the upgrade.'."\n", 'type' => 'string', 'example' => 'd', ], 'UpgradeCpu' => [ 'description' => 'The number of CPU cores after the upgrade.'."\n", 'type' => 'string', 'example' => '8', ], 'UpgradeDescContent' => [ 'description' => 'The description of the upgrade.'."\n", 'type' => 'string', 'example' => 'test', ], 'UpgradeDiskSize' => [ 'description' => 'The disk capacity after the upgrade.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1024', ], 'UpgradeMaxConnections' => [ 'description' => 'The maximum number of concurrent connections after the upgrade.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '70', ], 'UpgradeMaxIombps' => [ 'description' => 'The maximum I/O throughput after the upgrade. Unit: Mbit/s.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'UpgradeMaxIops' => [ 'description' => 'The maximum IOPS after the upgrade.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '70', ], 'UpgradeMemory' => [ 'description' => 'The memory size after the upgrade.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1024', ], 'UpgradeReferencePrice' => [ 'description' => 'The reference price of the upgrade.'."\n", 'type' => 'string', 'example' => '23333.1', ], 'UpgradeStorageType' => [ 'description' => 'The storage type after the upgrade.'."\n", 'type' => 'string', 'example' => 'cloud_essd', ], ], ], ], 'RegionId' => [ 'description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-shenzhen', ], 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'required' => true, 'example' => '7D8F09DB-1124-5D78-A520-FF88FAF4351B', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AliUid\\": 1979008652307170,\\n \\"Bid\\": \\"26842\\",\\n \\"Items\\": [\\n {\\n \\"Category\\": \\"Basic\\",\\n \\"ChargeType\\": \\"POSTPAY\\",\\n \\"ClassCode\\": \\"rds.mysql.s3.large\\",\\n \\"ClassGroup\\": \\"x\\",\\n \\"Cpu\\": \\"2\\",\\n \\"DiskSize\\": 900,\\n \\"Engine\\": \\"MySQL\\",\\n \\"EngineVersion\\": \\"8.0\\",\\n \\"InstanceId\\": \\"rm-uf62br2491p5l****\\",\\n \\"InstanceName\\": \\"rm-uf62br2491p5l****\\",\\n \\"MaxConnections\\": 60,\\n \\"MaxIombps\\": 100,\\n \\"MaxIops\\": 30,\\n \\"Memory\\": 1024,\\n \\"StorageType\\": \\"cloud_essd\\",\\n \\"UpgradeCategory\\": \\"HighAvailability\\",\\n \\"UpgradeClassCode\\": \\"rds.mysql.s3.large\\",\\n \\"UpgradeClassGroup\\": \\"d\\",\\n \\"UpgradeCpu\\": \\"8\\",\\n \\"UpgradeDescContent\\": \\"test\\",\\n \\"UpgradeDiskSize\\": 1024,\\n \\"UpgradeMaxConnections\\": 70,\\n \\"UpgradeMaxIombps\\": 200,\\n \\"UpgradeMaxIops\\": 70,\\n \\"UpgradeMemory\\": 1024,\\n \\"UpgradeReferencePrice\\": \\"23333.1\\",\\n \\"UpgradeStorageType\\": \\"cloud_essd\\"\\n }\\n ],\\n \\"RegionId\\": \\"cn-shenzhen\\",\\n \\"RequestId\\": \\"7D8F09DB-1124-5D78-A520-FF88FAF4351B\\"\\n}","type":"json"}]', 'title' => 'DescribeMarketingActivity', ], 'DescribeQuickSaleConfig' => [ 'summary' => '查询RDS快捷售卖配置', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the [DescribeRegions](~~26243~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'Engine', 'in' => 'query', 'schema' => [ 'description' => 'The database engine of the instance. Valid values:'."\n" ."\n" .'* **MySQL**'."\n" .'* **SQLServer**'."\n" .'* **PostgreSQL**'."\n" .'* **MariaDB**'."\n", 'type' => 'string', 'required' => false, 'example' => 'MySQL', ], ], [ 'name' => 'Commodity', 'in' => 'query', 'schema' => [ 'description' => 'The product code. Valid values:'."\n" ."\n" .'* rds: The instance is a subscription instance.'."\n" .'* bards: The instance is a pay-as-you-go instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rds', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'Commodity' => [ 'description' => 'The product code. Valid values:'."\n" ."\n" .'* rds: The instance is a subscription instance.'."\n" .'* bards: The instance is a pay-as-you-go instance.'."\n", 'type' => 'string', 'example' => 'rds', ], 'Items' => [ 'description' => 'The configuration details of the product.'."\n", 'type' => 'object', ], 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '5DFFE9EC-3369-5937-A4E2-507C0C86A4C6', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Commodity\\": \\"rds\\",\\n \\"Items\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"RequestId\\": \\"5DFFE9EC-3369-5937-A4E2-507C0C86A4C6\\"\\n}","type":"json"}]', 'title' => 'DescribeQuickSaleConfig', ], 'DescribeResourceDetails' => [ 'summary' => '概览页资源详情', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxxxxx', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the [DescribeRegions](~~26243~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-bp1ul2y10grt91m68', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfm3kyoa2wqhyy', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'BackupDataSize' => [ 'description' => 'The storage that is occupied by data backup files, excluding archived backup files, on the instance. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '8139046912', ], 'BackupLogSize' => [ 'description' => 'The size of the backup log. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '21183797', ], 'BackupSize' => [ 'description' => 'The size of the backup data. Unit: MB.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '53002759', ], 'DbInstanceStorage' => [ 'description' => 'The disk capacity of the instance.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'DbProxyInstanceName' => [ 'description' => 'The name of the proxy instance.'."\n", 'type' => 'string', 'example' => 'mr-n1m1wjrylfolvrt67s', ], 'DiskUsed' => [ 'description' => 'The total storage used. The value is the sum of the DataSize and LogSize values. Unit: bytes. The value -1 indicates that no data files or log files are stored.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '4871684096', ], 'InstanceStorageType' => [ 'description' => 'The storage type of the instance.'."\n", 'type' => 'string', 'example' => 'cloud_essd', ], 'RdsEcsSecurityGroupRel' => [ 'description' => 'The rule for the IP address whitelist of the instance.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'SecurityGroupName' => [ 'description' => 'The name of the security group.'."\n", 'type' => 'string', 'example' => 'test_switch', ], ], ], ], 'Region' => [ 'description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-beijing', ], 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'EA815761-F7AC-5CFE-A1AC-709D6A00B58A', ], 'ResourceGroupId' => [ 'description' => 'The resource group ID.'."\n", 'type' => 'string', 'example' => 'rg-acfmv3h25bj7yhq', ], 'SecurityIPList' => [ 'description' => 'The IP address whitelist of the instance. For more information, see [Configure IP address whitelists](~~43185~~). If the returned IP address whitelist contains more than one entry, these entries are separated with commas (,). Each entry is unique and up to 1,000 entries are returned. The entries in the IP address whitelist must be in one of the following formats:'."\n" ."\n" .'* IP addresses, such as 10.10.XX.XX.'."\n" .'* CIDR blocks, such as 10.10.XX.XX/24. In this example, 24 indicates that the prefix of each IP address in the IP address whitelist is 24 bits in length. You can replace 24 with a value within the range of 1 to 32.'."\n" ."\n" .'If this parameter is not specified, the default IP address whitelist is used.'."\n", 'type' => 'string', 'example' => '172.16.1.14,172.16.1.13,172.16.1.44,172.16.1.43,172.16.1.74,172.16.1.73', ], 'VSwitchId' => [ 'description' => 'The vSwitch ID.'."\n" ."\n" .'> The vSwitch must belong to the same zone as the instance.'."\n", 'type' => 'string', 'example' => 'vsw-2zelwi1jd271p670lzl8h', ], 'VpcId' => [ 'description' => 'The ID of the virtual private cloud (VPC).'."\n", 'type' => 'string', 'example' => 'vpc-wz9rbibex7v0lxbeyo6at', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance does not exist or is not supported.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"BackupDataSize\\": 8139046912,\\n \\"BackupLogSize\\": 21183797,\\n \\"BackupSize\\": 53002759,\\n \\"DbInstanceStorage\\": 200,\\n \\"DbProxyInstanceName\\": \\"mr-n1m1wjrylfolvrt67s\\",\\n \\"DiskUsed\\": 4871684096,\\n \\"InstanceStorageType\\": \\"cloud_essd\\",\\n \\"RdsEcsSecurityGroupRel\\": [\\n {\\n \\"SecurityGroupName\\": \\"test_switch\\"\\n }\\n ],\\n \\"Region\\": \\"cn-beijing\\",\\n \\"RequestId\\": \\"EA815761-F7AC-5CFE-A1AC-709D6A00B58A\\",\\n \\"ResourceGroupId\\": \\"rg-acfmv3h25bj7yhq\\",\\n \\"SecurityIPList\\": \\"172.16.1.14,172.16.1.13,172.16.1.44,172.16.1.43,172.16.1.74,172.16.1.73\\",\\n \\"VSwitchId\\": \\"vsw-2zelwi1jd271p670lzl8h\\",\\n \\"VpcId\\": \\"vpc-wz9rbibex7v0lxbeyo6at\\"\\n}","type":"json"}]', 'title' => 'DescribeResourceDetails', ], 'EvaluateLocalExtendDisk' => [ 'summary' => '评估紧急本地扩容磁盘解锁可使用的磁盘空间', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the [DescribeRegions](~~26243~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => [ 'description' => 'The instance name.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-m5e999iqm65******', ], ], [ 'name' => 'Storage', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => [ 'description' => 'The new storage capacity. Unit: GB.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1000', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-ac****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Available' => [ 'description' => 'Indicates whether the instance is available. Valid values: true and false.'."\n", 'type' => 'string', 'example' => 'True', ], 'DBInstanceId' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-bp1375i66nd******', ], 'DBInstanceTransType' => [ 'description' => 'The data transfer type supported by the instance.'."\n", 'type' => 'string', 'example' => '0', ], 'LocalUpgradeDiskLimit' => [ 'description' => 'The maximum value of the local disk. Unit: GB.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '100', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'A4C4D26F-E5CE-5A28-8C54-46A6FB318223', ], ], 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidUserId.NotSupport', 'errorMessage' => 'The user ID has no permission.', ], [ 'errorCode' => 'InvalidTransType.NotSupport', 'errorMessage' => 'When forcing local disk expansion, the instance must be in a locked state.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'IncorrectDBType', 'errorMessage' => 'Current DB type does not support this operation.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The host is not found.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Available\\": \\"true\\",\\n \\"DBInstanceId\\": \\"rm-wz9s06u4drm******\\\\n\\",\\n \\"DBInstanceTransType\\": \\"0\\",\\n \\"LocalUpgradeDiskLimit\\": 100,\\n \\"RequestId\\": \\"A4C4D26F-E5CE-5A28-8C54-46A6FB318223\\"\\n}","type":"json"}]', 'title' => 'EvaluateLocalExtendDisk', ], 'ModifyCustinsResource' => [ 'summary' => '修改实例资源', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the [DescribeDBInstances](~~26232~~) operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-j5ekvfeengm******', ], ], [ 'name' => 'ResourceType', 'in' => 'query', 'schema' => [ 'description' => 'The resource type.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Memory', ], ], [ 'name' => 'IncreaseRatio', 'in' => 'query', 'schema' => [ 'description' => 'The increase rate in percentage.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '10', ], ], [ 'name' => 'AdjustDeadline', 'in' => 'query', 'schema' => [ 'description' => 'The deadline for the modification.'."\n", 'type' => 'string', 'required' => false, 'example' => '2022-12-31 23:59:06', ], ], [ 'name' => 'RestoreOriginalSpecification', 'in' => 'query', 'schema' => [ 'description' => 'The original value. This parameter must be specified when the **ResourceType** parameter is set to **instance**.'."\n", 'type' => 'string', 'required' => false, 'example' => '200', ], ], [ 'name' => 'TargetValue', 'in' => 'query', 'schema' => [ 'description' => 'The target value. This parameter is available only if you set the ScalingRuleType parameter to TargetTrackingScalingRule or PredictiveScalingRule. The value must be greater than 0 and can contain up to three decimal places.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '999999', 'minimum' => '0', 'example' => '3000', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '6B5A6839-31A7-58D4-9F96-772BFAFD1CB5', ], 'TaskId' => [ 'description' => 'The task ID.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '507******', ], ], 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidCPUZoom.NotSupport', 'errorMessage' => 'The param cpuZoom not in valid range', ], [ 'errorCode' => 'InvalidCPUShar.NotSupport', 'errorMessage' => 'The param cpuShar not in valid range', ], [ 'errorCode' => 'InvalidMemoryZoom.NotSupport', 'errorMessage' => 'The param memory zoom not in valid range', ], [ 'errorCode' => 'InvalidIOPSZoom.NotSupport', 'errorMessage' => 'The param iops zoom not in valid range', ], [ 'errorCode' => 'InvalidMaxConnZoom.NotSupport', 'errorMessage' => 'The param MaxConne zoom not in valid range', ], [ 'errorCode' => 'InvalidResource.Type.NotSupport', 'errorMessage' => 'The param Resource Type not in valid range', ], [ 'errorCode' => 'InvalidIncreaseRatio.Type.NotSupport', 'errorMessage' => 'Insufficient host resources, please reduce the ratio', ], [ 'errorCode' => 'InvalidDedicatedHostGroupName', 'errorMessage' => 'The DedicatedHostGroupName is invalid', ], [ 'errorCode' => 'InvalidInsName', 'errorMessage' => 'The InsName is invalid', ], [ 'errorCode' => 'InvalidIncreaseValue.NotEnouth', 'errorMessage' => 'Resource is not enough.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'ClusterTypeError', 'errorMessage' => 'Custins Cluster Type Error, Support User Cluster', ], [ 'errorCode' => 'DedicatedHostNameIsNull', 'errorMessage' => 'Dedicated Host Name Is Null!', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'PhysicalCustins.NotFound', 'errorMessage' => 'Physical Custins Not Found!', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'Current cluster not found host info!', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6B5A6839-31A7-58D4-9F96-772BFAFD1CB5\\",\\n \\"TaskId\\": 0\\n}","type":"json"}]', 'title' => 'ModifyCustinsResource', ], 'PreCheckCreateOrderForDeleteDBNodes' => [ 'summary' => '删除节点创建订单预检查', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the generated token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOC****', ], ], [ 'name' => 'CommodityCode', 'in' => 'query', 'schema' => [ 'description' => 'The commodity code. Valid value:'."\n" ."\n" .'* **bards**: The instance is a pay-as-you-go primary instance.'."\n" .'* **rds**: The instance is a subscription primary instance.'."\n" .'* **rords**: The instance is a pay-as-you-go read-only instance.'."\n" .'* **rds_rordspre_public_cn**: The instance is a subscription read-only instance.'."\n" .'* **bards_intl**: The instance is a pay-as-you-go primary instance.'."\n" .'* **rds_intl**: The instance is a subscription primary instance.'."\n" .'* **rords_intl**: The instance is a pay-as-you-go read-only instance.'."\n" .'* **rds_rordspre_public_intl**: The instance is a subscription read-only instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rds', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rm-wz9rziy3he051if82', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the [DescribeRegions](~~26243~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'ZoneId', 'in' => 'query', 'schema' => [ 'description' => 'The zone ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-a', ], ], [ 'name' => 'Resource', 'in' => 'query', 'schema' => [ 'description' => 'The resource of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'buy', ], ], [ 'name' => 'AutoPay', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to automatically complete the payment. Valid values:'."\n" ."\n" .'1. **true**: automatically completes the payment. You must make sure that your account balance is sufficient.'."\n" .'2. **false**: does not automatically complete the payment. An unpaid order is generated.'."\n" ."\n" .'> The default value is true. If your account balance is insufficient, you can set the AutoPay parameter to false to generate an unpaid order. Then, you can log on to the ApsaraDB RDS console to complete the payment.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'True', ], ], [ 'name' => 'PromotionCode', 'in' => 'query', 'schema' => [ 'description' => 'The coupon code.'."\n", 'type' => 'string', 'required' => false, 'example' => 'aliwood-1688-mobile-promotion', ], ], [ 'name' => 'EngineVersion', 'in' => 'query', 'schema' => [ 'description' => 'The major engine version of the destination instance. The value of this parameter varies based on the value of **Engine**.'."\n" ."\n" .'* Valid values when Engine is set to MySQL: **5.5, 5.6, 5.7, and 8.0**'."\n" .'* Valid values when Engine is set to SQLServer: **2008r2, 08r2\\_ent_ha, 2012, 2012\\_ent_ha, 2012\\_std_ha, 2012\\_web, 2014\\_std_ha, 2016\\_ent_ha, 2016\\_std_ha, 2016\\_web, 2017\\_std_ha, 2017\\_ent, 2019\\_std_ha, and 2019\\_ent**'."\n" .'* Valid values when Engine is set to PostgreSQL: **10.0, 11.0, 12.0, 13.0, 14.0, and 15.0**'."\n", 'type' => 'string', 'required' => false, 'example' => '8.0', ], ], [ 'name' => 'NodeType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the database node. Valid value:'."\n" ."\n" .'* **Master**: the primary node'."\n" .'* **Slave**: the secondary node'."\n", 'type' => 'string', 'required' => false, 'example' => 'Master', ], ], [ 'name' => 'BusinessInfo', 'in' => 'query', 'schema' => [ 'description' => 'The additional business information about the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => '{\\"promotion_input_param\\":\\"{\\\\\\"promotionFilter\\\\\\":{},\\\\\\"promotionOptionCode\\\\\\":\\\\\\"youhui_quan\\\\\\"}\\"}', ], ], [ 'name' => 'DBNodeId', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The node IDs.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The node ID.'."\n" ."\n" .'> You must specify one of the `DBNodeId` and `DBClusterId` parameters. You can call the [DescribeDBClusters](~~98094~~) operation to query the details of the clusters that belong to your Alibaba Cloud account, such as node IDs.'."\n", 'type' => 'string', 'required' => false, 'example' => '[\\"rn-704fvfg7a1841gahd\\"]', ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Failures' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Failures' => [ 'description' => 'The information about the failed order.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Code' => [ 'description' => 'The response code. Valid values:'."\n" ."\n" .'* **200**: success'."\n" .'* **400**: client error'."\n" .'* **401**: identity authentication failed'."\n" .'* **404**: requested page not found'."\n" .'* **500**: server error'."\n", 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'success', ], ], ], ], ], ], 'PreCheckResult' => [ 'description' => 'The precheck result.'."\n", 'type' => 'boolean', 'example' => 'True', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '9B415BC6-FE84-5323-A255-42CF330DB99C', ], ], 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'OperationDenied.InvalidStorageSize', 'errorMessage' => 'The storage size limit is exceeded.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'Forbidden.Authentication', 'errorMessage' => 'The operation is forbidden by Aliyun Realname Authentication System.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Failures\\": {\\n \\"Failures\\": [\\n {\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\"\\n }\\n ]\\n },\\n \\"PreCheckResult\\": true,\\n \\"RequestId\\": \\"9B415BC6-FE84-5323-A255-42CF330DB99C\\"\\n}","type":"json"}]', 'title' => 'PreCheckCreateOrderForDeleteDBNodes', ], 'QueryRecommendByCode' => [ 'summary' => 'rds机器人热点问题', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'Code', 'in' => 'query', 'schema' => [ 'description' => 'The code.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rds_recommend', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The returned data.'."\n", 'type' => 'string', 'example' => '{'."\n" .' "SupportOnlineResizeDisk": true,'."\n" .' "DBInstanceName": "rm-bp****",'."\n" .' "maxSupportDiskSizeGB": 6144'."\n" .'}', ], 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '90496720-2319-42A8-87CD-FCE4DF95EBED', ], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'True', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"{\\\\n \\\\\\"SupportOnlineResizeDisk\\\\\\": true,\\\\n \\\\\\"DBInstanceName\\\\\\": \\\\\\"rm-bp****\\\\\\",\\\\n \\\\\\"maxSupportDiskSizeGB\\\\\\": 6144\\\\n}\\",\\n \\"RequestId\\": \\"90496720-2319-42A8-87CD-FCE4DF95EBED\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'QueryRecommendByCode', ], 'CreateOrderForDeleteDBNodes' => [ 'summary' => 'Deletes a node from an ApsaraDB RDS for MySQL instance that runs RDS Cluster Edition.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxx', ], ], [ 'name' => 'CommodityCode', 'in' => 'query', 'schema' => [ 'description' => 'The commodity code. Valid values:'."\n" ."\n" .'* **bards**: The instance is a pay-as-you-go primary instance.'."\n" .'* **rds**: The instance is a subscription primary instance.'."\n" .'* **rords**: The instance is a pay-as-you-go read-only instance.'."\n" .'* **rds_rordspre_public_cn**: The instance is a subscription read-only instance.'."\n" .'* **bards_intl**: The instance is a pay-as-you-go primary instance.'."\n" .'* **rds_intl**: The instance is a subscription primary instance.'."\n" .'* **rords_intl**: The instance is a pay-as-you-go read-only instance.'."\n" .'* **rds_rordspre_public_intl**: The instance is a subscription read-only instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'bards', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID. You can call the [DescribeDBInstances](~~610396~~) operation to query the ID of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rm-8vb******', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the [DescribeRegions](~~610399~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'ZoneId', 'in' => 'query', 'schema' => [ 'description' => 'The zone ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-a', ], ], [ 'name' => 'Resource', 'in' => 'query', 'schema' => [ 'description' => 'The resources.'."\n", 'type' => 'string', 'required' => false, 'example' => 'buy', ], ], [ 'name' => 'AutoPay', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to automatically complete the payment. Valid values:'."\n" ."\n" .'1. **true**: You must make sure that your account balance is sufficient.'."\n" .'2. **false**: An unpaid order is generated.'."\n" ."\n" .'> Default value: true. If your account balance is insufficient, you can set the AutoPay parameter to false to generate an unpaid order. Then, you can log on to the ApsaraDB RDS console to complete the payment.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'PromotionCode', 'in' => 'query', 'schema' => [ 'description' => 'The coupon code.'."\n", 'type' => 'string', 'required' => false, 'example' => 'aliwood-1688-mobile-promotion', ], ], [ 'name' => 'EngineVersion', 'in' => 'query', 'schema' => [ 'description' => 'The database engine version of the instance. Valid values:'."\n" ."\n" .'Valid values if you set Engine to MySQL: **5.5, 5.6, 5.7, and 8.0**'."\n", 'type' => 'string', 'required' => false, 'example' => '5.7', ], ], [ 'name' => 'NodeType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the database node. Valid values:'."\n" ."\n" .'* **Master**: the primary node'."\n" .'* **Slave**: the secondary node'."\n", 'type' => 'string', 'required' => false, 'example' => 'Master', ], ], [ 'name' => 'BusinessInfo', 'in' => 'query', 'schema' => [ 'description' => 'The additional business information about the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => '{\\"shopCartItemId\\":\\"25******\\",\\"produceDriver\\":\\"NoOrder\\",\\"aliyun_shopcart_order_source\\":\\"fromShopcart\\",\\"shopCartId\\":\\"10190203suffix20230509******\\"}', ], ], [ 'name' => 'DBNodeId', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'An array that consists of information about the ID of the node.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The node ID. You can use one of the following methods to query the ID of the node:'."\n" ."\n" .'* Log on to the ApsaraDB RDS console, go to the instance details page, and then view the ID of the node in the instance topology section.'."\n" .'* Call the [DescribeDBInstanceAttribute](~~610394~~) operation to query the ID of the node.'."\n", 'type' => 'string', 'required' => false, 'example' => '[\\"rn-00c******\\"]', ], 'required' => false, ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy*****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'DBInstanceId' => [ 'description' => 'The instance ID'."\n", 'type' => 'string', 'example' => 'rm-7xv******', ], 'OrderId' => [ 'description' => 'The order ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '221172852******', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '49BC2500-8078-5AC4-A545-20AA5945B0E6', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'OperationDenied.MasterDBInstanceState', 'errorMessage' => 'The Primary instance in the current state does not support this operation. Try again when the Primary instance is in Running state.', ], [ 'errorCode' => 'GeneralIns.Creating', 'errorMessage' => 'The general instance is creating.', ], [ 'errorCode' => 'IncompleteAccountInfo', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'IncompleteTaxInfo', 'errorMessage' => 'Your tax information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'InvalidPaymentMethod.Incomplete', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'InvalidPaymentMethod.Missing', 'errorMessage' => 'Your payment method is incomplete. We recommend that you add a payment method.', ], [ 'errorCode' => 'InsuffcientBalanceOrBankAccount', 'errorMessage' => 'Add a payment method or add funds to the prepayment balance. Get started by creating an instance.', ], [ 'errorCode' => 'DBNodeIdParameterInvalid', 'errorMessage' => 'The specified parameter DBNodeId is malformed.', ], [ 'errorCode' => 'DBNodeIdParameterNotFound', 'errorMessage' => 'The specified parameter DBNodeId is required.', ], [ 'errorCode' => 'DBNodeParameterTooFewItems', 'errorMessage' => 'The specified parameter DBNode has too few items.', ], [ 'errorCode' => 'DBNodeFormatFault', 'errorMessage' => 'The specified parameter DBNode is malformed', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'Forbidden.Authentication', 'errorMessage' => 'The operation is forbidden by Aliyun Realname Authentication System.', ], [ 'errorCode' => 'GroupReplicationNotSupport.InvalidEngineVersion', 'errorMessage' => 'Group Replication requires the instance engine version to be 8.0.', ], [ 'errorCode' => 'GroupReplicationNotSupport.InvalidNodeClassCode', 'errorMessage' => 'Group Replication requires the ClassCode of each node to be consistent.', ], [ 'errorCode' => 'GroupReplicationNotSupport.InvalidNodeNum', 'errorMessage' => 'Group Replication is not supported, the number of nodes must be an odd number greater than or equal to 3.', ], [ 'errorCode' => 'GroupReplicationNotSupport.InvalidXengine', 'errorMessage' => 'Group Replication is not supported because the instance has xengine tables.', ], [ 'errorCode' => 'GroupReplicationNotSupport.MemoryTooSmall', 'errorMessage' => 'Group Replication is not supported because the memory is too small.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DBInstanceId\\": \\"rm-7x******\\",\\n \\"OrderId\\": 0,\\n \\"RequestId\\": \\"49BC2500-8078-5AC4-A545-20AA5945B0E6\\"\\n}","type":"json"}]', 'title' => 'CreateOrderForDeleteDBNodes', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'RDS MySQL'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'> Before you call this operation, read the following topics and make sure that you fully understand the prerequisites and impacts of this operation.'."\n" ."\n" .'[Delete a node from an ApsaraDB RDS for MySQL instance that runs RDS Cluster Edition](~~464130~~)'."\n", ], 'DescribeSQLServerUpgradeVersions' => [ 'summary' => '查询SQLServer升级版本', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOC****', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'rm-xx1xxx2****'."\n", ], ], [ 'name' => 'EngineVersion', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => '2016_web', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Items' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Item' => [ 'description' => '', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'CurrentVersion' => [ 'description' => '', 'type' => 'string', 'example' => '2016_web', ], 'SQLServerUpgradeVersions' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'SQLServerUpgradeVersion' => [ 'description' => '', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'DBInstanceClassItems' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'DBInstanceClassItem' => [ 'description' => '', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'CPU' => [ 'description' => '', 'type' => 'string', 'example' => '2', ], 'DBInstanceClass' => [ 'description' => '', 'type' => 'string', 'example' => 'mssql.x4.medium.s2', ], 'DBInstanceClassType' => [ 'description' => '', 'type' => 'string', 'example' => '', ], 'Group' => [ 'description' => '', 'type' => 'string', 'example' => '2', ], 'Memory' => [ 'description' => '', 'type' => 'string', 'example' => '8GB', ], ], ], ], ], ], 'EnableUpgrade' => [ 'description' => '', 'type' => 'string', 'example' => 'NO/YES', ], 'Version' => [ 'description' => '', 'type' => 'string', 'example' => '2016_std', ], ], ], ], ], ], ], ], ], ], ], 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => '866F5EB8-4650-4061-87F0-379F6F******', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Items\\": {\\n \\"Item\\": [\\n {\\n \\"CurrentVersion\\": \\"2016_web\\",\\n \\"SQLServerUpgradeVersions\\": {\\n \\"SQLServerUpgradeVersion\\": [\\n {\\n \\"DBInstanceClassItems\\": {\\n \\"DBInstanceClassItem\\": [\\n {\\n \\"CPU\\": \\"2\\",\\n \\"DBInstanceClass\\": \\"mssql.x4.medium.s2\\",\\n \\"DBInstanceClassType\\": \\"独享型\\",\\n \\"Group\\": \\"2\\",\\n \\"Memory\\": \\"8GB\\"\\n }\\n ]\\n },\\n \\"EnableUpgrade\\": \\"NO/YES\\",\\n \\"Version\\": \\"2016_std\\"\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"RequestId\\": \\"866F5EB8-4650-4061-87F0-379F6F******\\"\\n}","type":"json"}]', ], 'DescribeActiveOperationMaintainConf' => [ 'summary' => '查询主动操作维护配置', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Config' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'CreatedTime' => [ 'description' => '', 'type' => 'string', 'example' => '2018-05-30T14:30:00Z', ], 'CycleTime' => [ 'description' => '', 'type' => 'string', 'example' => '1', ], 'CycleType' => [ 'description' => '', 'type' => 'string', 'example' => 'Week', ], 'MaintainEndTime' => [ 'description' => '', 'type' => 'string', 'example' => '20:00:00Z', ], 'MaintainStartTime' => [ 'description' => '', 'type' => 'string', 'example' => '18:00:00Z', ], 'ModifiedTime' => [ 'description' => '', 'type' => 'string', 'example' => '2018-05-30T14:30:00Z', ], 'Status' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], 'HasConfig' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => '4438AC3E-ABE3-5943-9436-***********', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'InvalidRequest', 'errorMessage' => 'Invalid Request.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Config\\": {\\n \\"CreatedTime\\": \\"2018-05-30T14:30:00Z\\",\\n \\"CycleTime\\": \\"1\\",\\n \\"CycleType\\": \\"Week\\",\\n \\"MaintainEndTime\\": \\"20:00:00Z\\",\\n \\"MaintainStartTime\\": \\"18:00:00Z\\",\\n \\"ModifiedTime\\": \\"2018-05-30T14:30:00Z\\",\\n \\"Status\\": 1\\n },\\n \\"HasConfig\\": 1,\\n \\"RequestId\\": \\"4438AC3E-ABE3-5943-9436-***********\\"\\n}","type":"json"}]', ], 'CreateMaskingRules' => [ 'summary' => '创建全密态规则', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'RuleName', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'rulename1', ], ], [ 'name' => 'MaskingAlgo', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => '[{"name": "aes-128-gcm"},'."\n" .' {"name":"sm4-128-gcm"}]', ], ], [ 'name' => 'DefaultAlgo', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'aes-128-gcm', ], ], [ 'name' => 'RuleConfig', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Columns' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'a', 'maxLength' => 100, 'minLength' => 1, ], 'required' => false, 'maxItems' => 100, 'minItems' => 1, ], 'Databases' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'testdb', 'maxLength' => 100, 'minLength' => 1, ], 'required' => false, 'maxItems' => 100, 'minItems' => 1, ], 'Tables' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'testtb', 'maxLength' => 100, 'minLength' => 1, ], 'required' => false, 'maxItems' => 100, 'minItems' => 1, ], ], 'required' => false, ], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'rm-t4n8t18o3*****d5', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ap-southeast-1', ], ], [ 'name' => 'DBName', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'testdb', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => '', 'type' => 'object', 'additionalProperties' => [ 'type' => 'string', 'description' => '', 'example' => 'rm-t4n8t18o******d5', ], ], 'Message' => [ 'description' => '', 'type' => 'string', 'example' => 'successful create', ], 'RequestId' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => '792233B1-76B8-5A01-92B4-**********864', ], 'Success' => [ 'description' => '', 'type' => 'string', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'IncorrectParameter.%s', 'errorMessage' => 'The following parameters are incorrect: %s.', ], [ 'errorCode' => 'InvalidParameterValue.NotStandard', 'errorMessage' => 'Invalid parameter format.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'ColumnEncryptionErrorCode.NOT_PURCHASED', 'errorMessage' => 'The instance has not enabled the column encryption service.', ], ], 403 => [ [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', ], [ 'errorCode' => 'ParamNotFound', 'errorMessage' => 'The parameter is not found for the interface.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], [ 'errorCode' => 'UnsupportedByBlueGreenDeployment', 'errorMessage' => 'Operation prohibited due to blue green deployment.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"key\\": \\"rm-t4n8t18o******d5\\"\\n },\\n \\"Message\\": \\"successful create\\",\\n \\"RequestId\\": \\"792233B1-76B8-5A01-92B4-**********864\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', ], 'ModifyAccountMaskingPrivilege' => [ 'summary' => '修改全密态用户权限', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'UserName', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'user1,user2', 'maxLength' => 1000, ], ], [ 'name' => 'ExpireTime', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => '2026-01-22T02:01:20Z', ], ], [ 'name' => 'Privilege', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'restrictedAccess', 'enum' => [ 'noneAccess', 'fullAccess', 'restrictedAccess', ], ], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'rm-t4n8t18o******6d5'."\n", ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ap-southeast-1', ], ], [ 'name' => 'DBName', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'myDB', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '', 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => '', 'type' => 'object', 'additionalProperties' => [ 'type' => 'string', 'example' => 'rm-t4n8t18o******6d5'."\n", 'description' => '', ], ], 'Message' => [ 'description' => '', 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => '2144F5CC-10C5-3B72-8C74-E52C********', ], 'Success' => [ 'description' => '', 'type' => 'string', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'ColumnEncryptionErrorCode.NOT_PURCHASED', 'errorMessage' => 'The instance has not enabled the column encryption service.', ], ], 403 => [ [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], [ 'errorCode' => 'UnsupportedByBlueGreenDeployment', 'errorMessage' => 'Operation prohibited due to blue green deployment.', ], ], [ [ 'errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance does not exist or is not supported.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"key\\": \\"rm-t4n8t18o******6d5\\\\n\\"\\n },\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"2144F5CC-10C5-3B72-8C74-E52C********\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', ], 'ModifyMaskingRules' => [ 'summary' => '修改全密态规则', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'RuleConfig', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Columns' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'a', 'maxLength' => 100, ], 'required' => false, 'maxItems' => 100, ], 'Databases' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'myDB', 'maxLength' => 100, ], 'required' => false, 'maxItems' => 100, ], 'Tables' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'myTable', 'maxLength' => 100, ], 'required' => false, 'maxItems' => 100, ], ], 'required' => false, ], ], [ 'name' => 'RuleName', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'rulename1', ], ], [ 'name' => 'MaskingAlgo', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => ' [{"name": "sha256"},'."\n" .' {"name":"sm4-128-gcm"}]', ], ], [ 'name' => 'DefaultAlgo', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'sm4-128-gcm', ], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'rm-t4n8t18o******6d5', ], ], [ 'name' => 'Enabled', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ap-southeast-1', ], ], [ 'name' => 'DBName', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'myDB', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '', 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => '', 'type' => 'object', 'additionalProperties' => [ 'type' => 'string', 'description' => '', 'example' => 'rm-t4n8t18o*****6d5', ], ], 'Message' => [ 'description' => '', 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => '8B1434A1-08A7-3E8C-A237-076A********', ], 'Success' => [ 'description' => '', 'type' => 'string', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidParameterValue.NotStandard', 'errorMessage' => 'Invalid parameter format.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'ColumnEncryptionErrorCode.NOT_PURCHASED', 'errorMessage' => 'The instance has not enabled the column encryption service.', ], ], 403 => [ [ 'errorCode' => 'ParamNotFound', 'errorMessage' => 'The parameter is not found for the interface.', ], [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance does not exist or is not supported.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"key\\": \\"rm-t4n8t18o*****6d5\\"\\n },\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"8B1434A1-08A7-3E8C-A237-076A********\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', ], 'DescribeMaskingRules' => [ 'summary' => '查询全密态规则', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'rm-t4n8t18o******5', ], ], [ 'name' => 'RuleName', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'test1,test2', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ap-southeast-1', ], ], [ 'name' => 'DBName', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'myDB', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Rules' => [ 'description' => '', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'DefaultAlgo' => [ 'description' => '', 'type' => 'string', 'example' => 'aes-128-gcm', ], 'Enabled' => [ 'description' => '', 'type' => 'string', 'example' => 'true', ], 'MaskingAlgo' => [ 'description' => '', 'type' => 'string', 'example' => '[{"name": "aes-128-gcm"},'."\n" .' {"name":"sm4-128-gcm"}]', ], 'RuleConfig' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Columns' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'string', 'example' => '*', ], ], 'Databases' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'string', 'example' => '*', ], ], 'Tables' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'string', 'example' => '*', ], ], ], ], 'RuleName' => [ 'description' => '', 'type' => 'string', 'example' => 'test', ], ], ], ], ], ], 'RequestId' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => '69779000-57A4-38F6-BF85-**********A2', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'ColumnEncryptionErrorCode.NOT_PURCHASED', 'errorMessage' => 'The instance has not enabled the column encryption service.', ], ], 403 => [ [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance does not exist or is not supported.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Rules\\": [\\n {\\n \\"DefaultAlgo\\": \\"aes-128-gcm\\",\\n \\"Enabled\\": \\"true\\",\\n \\"MaskingAlgo\\": \\"[{\\\\\\"name\\\\\\": \\\\\\"aes-128-gcm\\\\\\"},\\\\n {\\\\\\"name\\\\\\":\\\\\\"sm4-128-gcm\\\\\\"}]\\",\\n \\"RuleConfig\\": {\\n \\"Columns\\": [\\n \\"*\\"\\n ],\\n \\"Databases\\": [\\n \\"*\\"\\n ],\\n \\"Tables\\": [\\n \\"*\\"\\n ]\\n },\\n \\"RuleName\\": \\"test\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"69779000-57A4-38F6-BF85-**********A2\\"\\n}","type":"json"}]', ], 'DeleteMaskingRules' => [ 'summary' => '删除全密态规则', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'RuleName', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'test', ], ], [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'rm-t4n8t18o******6d5', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ap-southeast-1', ], ], [ 'name' => 'DBName', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'myDB', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '', 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => '', 'type' => 'object', 'additionalProperties' => [ 'type' => 'string', 'example' => 'rm-t4n8t18o******6d5'."\n", 'description' => '', ], ], 'Message' => [ 'description' => '', 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => '5EEE1ED1-A459-38D2-840C-0C49********', ], 'Success' => [ 'description' => '', 'type' => 'string', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'ParamNotExist', 'errorMessage' => 'This param Not Exist', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'ColumnEncryptionErrorCode.NOT_PURCHASED', 'errorMessage' => 'The instance has not enabled the column encryption service.', ], ], 403 => [ [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'Invalid DBInstanceId NotFound.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"key\\": \\"rm-t4n8t18o******6d5\\\\n\\"\\n },\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"5EEE1ED1-A459-38D2-840C-0C49********\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', ], 'DescribeAccountMaskingPrivilege' => [ 'summary' => 'Query the encryption or data masking permission configuration of an account in a specified instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'rm-t4n8t18o******6d5', ], ], [ 'name' => 'UserName', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'rds', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ap-southeast-1', ], ], [ 'name' => 'DBName', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'myDB', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'UserPrivilege' => [ 'description' => '', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ExpireTime' => [ 'description' => '', 'type' => 'string', 'example' => '2026-01-22T02:01:20Z', ], 'Privilege' => [ 'description' => '', 'type' => 'string', 'example' => 'restrictedAccess', ], 'UserName' => [ 'description' => '', 'type' => 'string', 'example' => 'rds', ], ], ], ], ], ], 'RequestId' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => 'D0073A98-52F1-3075-8256-394**********', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'ColumnEncryptionErrorCode.NOT_PURCHASED', 'errorMessage' => 'The instance has not enabled the column encryption service.', ], ], 403 => [ [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance does not exist or is not supported.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"UserPrivilege\\": [\\n {\\n \\"ExpireTime\\": \\"2026-01-22T02:01:20Z\\",\\n \\"Privilege\\": \\"restrictedAccess\\",\\n \\"UserName\\": \\"rds\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"D0073A98-52F1-3075-8256-394**********\\"\\n}","type":"json"}]', 'title' => 'Query account encryption or data masking permissions', ], 'DeleteParameterTimedScheduleTask' => [ 'summary' => 'RDS MySQL删除修改参数运行任务', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'rm-uf6wjk5****', ], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '41698', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => '16C62438-491B-5C02-9B49-BA924A1372A2', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'ScheduleTask.NotFound', 'errorMessage' => 'Parameter modification timed task not found.', ], [ 'errorCode' => 'ScheduleTask.OperationFailed', 'errorMessage' => 'Parameter modification timed task operation failed.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"16C62438-491B-5C02-9B49-BA924A1372A2\\"\\n}","type":"json"}]', ], 'DescribeParameterTimedScheduleTask' => [ 'summary' => 'RDS MySQL查询修改参数运行时间列表', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'DbInstanceName', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'rm-2ze2za3is7baay****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => 'A807C95D-410C-5BB5-96C0-C6E09F2C3D36', ], 'TaskList' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'TaskId' => [ 'description' => '', 'type' => 'string', 'example' => '27056921', ], 'DBInstanceName' => [ 'description' => '', 'type' => 'string', 'example' => 'rm-2ze2za3is7baay****', ], 'Status' => [ 'description' => '', 'type' => 'string', 'example' => 'PENDING', ], 'SwitchTime' => [ 'description' => '', 'type' => 'string', 'example' => '2022-05-06T09:24:00Z', ], 'Parameters' => [ 'description' => '', 'type' => 'string', 'example' => '{"auto_increment_increment":"1000","back_log":"99"}', ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A807C95D-410C-5BB5-96C0-C6E09F2C3D36\\",\\n \\"TaskList\\": [\\n {\\n \\"TaskId\\": \\"27056921\\",\\n \\"DBInstanceName\\": \\"rm-2ze2za3is7baay****\\",\\n \\"Status\\": \\"PENDING\\",\\n \\"SwitchTime\\": \\"2022-05-06T09:24:00Z\\",\\n \\"Parameters\\": \\"{\\\\\\"auto_increment_increment\\\\\\":\\\\\\"1000\\\\\\",\\\\\\"back_log\\\\\\":\\\\\\"99\\\\\\"}\\"\\n }\\n ]\\n}","type":"json"}]', ], 'ModifyParameterTimedScheduleTask' => [ 'summary' => 'RDS MySQL修改参数定时任务', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'DBInstanceName', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'pgm-bp102g323jd4****', ], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '440437220', ], ], [ 'name' => 'SwitchTime', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => '2022-05-06T09:24:00Z', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => '6EF82B07-28D2-48D1-B5D6-7E78FED277C7', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'ScheduleTask.NotFound', 'errorMessage' => 'Parameter modification timed task not found.', ], [ 'errorCode' => 'ScheduleTask.OperationFailed', 'errorMessage' => 'Parameter modification timed task operation failed.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], ], 403 => [ [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6EF82B07-28D2-48D1-B5D6-7E78FED277C7\\"\\n}","type":"json"}]', ], 'DescribeDBInstanceCLS' => [ 'summary' => '查询RDS实例的列加密（CLS）配置信息', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-t4n8t18o******6d5'."\n", ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => 'D0073A98-52F1-3075-8256-3943F*******', ], 'EncryptionKey' => [ 'description' => '', 'type' => 'string', 'example' => 'acs:kms:cn-hangzhou:123456789:key/xxxxx', ], 'EncryptionKeyMode' => [ 'description' => '', 'type' => 'string', 'example' => 'KMS', ], 'Algorithm' => [ 'description' => '', 'type' => 'string', 'example' => 'AES_256_GCM', ], 'WhiteListMode' => [ 'description' => '', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => '%s', 'errorMessage' => 'DB Operation Failed:%s.', ], [ 'errorCode' => 'Connect.Timeout', 'errorMessage' => 'Service can not connect to instance temporarily.', ], [ 'errorCode' => 'SqlExcutionFailed', 'errorMessage' => 'Failed to connect to host: connection timed out.', ], [ 'errorCode' => 'DbossGeneralError', 'errorMessage' => 'The instance is being created. Please wait.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'ConcurrentLimit', 'errorMessage' => 'The request processing has been concurrent limit.', ], [ 'errorCode' => 'ColumnEncryptionErrorCode.NOT_PURCHASED', 'errorMessage' => 'The instance has not enabled the column encryption service.', ], ], 403 => [ [ 'errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance engine and type does not support operations.', ], [ 'errorCode' => 'IncorrectEngineVersion', 'errorMessage' => 'The engine version does not support the operation.', ], [ 'errorCode' => 'DBSizeExceeded', 'errorMessage' => 'Exceeding the allowed DB size of DB instance.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBName.NotFound', 'errorMessage' => 'Specified one or more DB name does not exist or DB status does not support.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 408 => [ [ 'errorCode' => 'NetworkOrSqlTimeoutError', 'errorMessage' => 'Failed to create login due to potential SQL Server overload or other issues that may cause the login creation fail. Please retry later.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0073A98-52F1-3075-8256-3943F*******\\",\\n \\"EncryptionKey\\": \\"749c1df7-****-****-****-****\\",\\n \\"EncryptionKeyMode\\": \\"kms_key\\",\\n \\"Algorithm\\": \\"AES_256_GCM\\",\\n \\"WhiteListMode\\": true\\n}","type":"json"}]', ], 'ModifyDBInstanceCLS' => [ 'summary' => '设置RDS实例开启/修改/关闭列加密状态', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-t4n8t18o******6d5'."\n", ], ], [ 'name' => 'EncryptionStatus', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Enabled', ], ], [ 'name' => 'EncryptionKey', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'acs:kms:cn-hangzhou:123456789:key/xxxxx', ], ], [ 'name' => 'RoleArn', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'acs:123456789:role/aliyunrdsinstanceencryptiondefaultrole', ], ], [ 'name' => 'EncryptionKeyMode', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'KMS', ], ], [ 'name' => 'EncryptionAlgorithm', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'AES_256_GCM', ], ], [ 'name' => 'WhiteListMode', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'IsRotate', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => '2144F5CC-10C5-3B72-8C74-E5***********', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => '%s', 'errorMessage' => 'DB Operation Failed:%s.', ], [ 'errorCode' => 'IncorrectDBCLSStatus', 'errorMessage' => 'Specified DB CLS status or CLS mode mode does not support this operation.', ], [ 'errorCode' => 'PermissionDenied', 'errorMessage' => 'The current account has not been authorized to allow RDS to access user\'s KMS services, authorization needs to be granted to this account.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'ColumnEncryptionErrorCode.NOT_PURCHASED', 'errorMessage' => 'The instance has not enabled the column encryption service.', ], ], 403 => [ [ 'errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', ], [ 'errorCode' => 'IncorrectEngineVersion', 'errorMessage' => 'Current engine version does not support operations.', ], [ 'errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', ], [ 'errorCode' => 'DBSizeExceeded', 'errorMessage' => 'Exceeding the allowed DB size of DB instance.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'ByokRoleArnNotFound', 'errorMessage' => 'The roleArn can not be null.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'this cluster not kms service.', ], [ 'errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is insufficient capacity available for the requested instance.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2144F5CC-10C5-3B72-8C74-E5***********\\"\\n}","type":"json"}]', ], 'CreateRCImage' => [ 'summary' => 'Creates a custom image for an RDS Custom instance.', 'path' => '', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', ], ], [ 'name' => 'SnapshotId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the snapshot from which to create the custom image. You can call the DescribeRCSnapshots operation to query the snapshot ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rcds-c9bjdl79vz5dx********', ], ], [ 'name' => 'ImageName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the custom image.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Created_from_rc-vma9w5z699x9********', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the RDS Custom instance.'."\n", 'type' => 'string', 'required' => false, 'example' => "\n" .'rc-vma9w5z699x93204****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'F8D78AED-5050-113C-A46E-7B346*******', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'InstanceId is invalid, not found.', ], [ 'errorCode' => 'InvalidParameter.ImageName', 'errorMessage' => 'The image name is null.', ], [ 'errorCode' => 'InvalidParameter.DuplicateImageName', 'errorMessage' => 'The image name is duplicated.', ], ], 404 => [ [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', ], ], 500 => [ [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F8D78AED-5050-113C-A46E-7B346*******\\"\\n}","type":"json"}]', 'title' => 'CreateRCImage', 'description' => '### [](#)Supported database engines'."\n" ."\n" .'* RDS MySQL'."\n" .'* RDS SQL Server'."\n" ."\n" .'### [](#)References'."\n" ."\n" .'* [Introduction to RDS Custom for MySQL](~~2844223~~)'."\n" .'* [Introduction to RDS Custom for SQL Server](~~2864363~~)'."\n" ."\n" .'### [](#)Usage'."\n" ."\n" .'* Method 1: Create a custom image by using a snapshot generated from the **system disk**. In this case, specify the SnapshotId and ImageName parameters at the same time in the request.'."\n" .'* Method 2: Create a custom image by using an RDS Custom instance. In this case, specify the InstanceId and ImageName parameters at the same time in the request.'."\n", ], 'ModifyDBInstanceVectorSupportStatus' => [ 'summary' => '修改实例向量支持状态', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'rm-2vc2bn5c5b7g6****', ], ], [ 'name' => 'Status', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'Scheduled', 'enum' => [ 'ON', 'OFF', ], ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => '16C62438-491B-5C02-9B49-BA924A1372A2', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'PendingActionOverdue', 'errorMessage' => 'the action execution time is already overdue', ], [ 'errorCode' => 'EngineMigration.ActionDisabled', 'errorMessage' => 'Specified action is disabled while custins is in engine migration.', ], [ 'errorCode' => 'Invalid.ParamGroupDBCategory', 'errorMessage' => 'ParamGroup category is basic, not standard.', ], [ 'errorCode' => 'InvalidEffectiveTime.SpecialTimeIsNull', 'errorMessage' => 'SpecialTime is not valid.', ], [ 'errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'Specified parameters is not valid.', ], [ 'errorCode' => 'StorageEngine.NotSupported', 'errorMessage' => 'Current instance storage engine dose not support this operation.', ], [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], [ 'errorCode' => 'SystemParamGroupCode.Format', 'errorMessage' => 'Specific DBParamGroupId is not valid.', ], [ 'errorCode' => 'Database.ConnectError', 'errorMessage' => 'Database connect error. please check instance status and database processlist', ], [ 'errorCode' => 'InvalidInstanceParameter', 'errorMessage' => 'Specified name for the instance parameter is not valid.', ], [ 'errorCode' => 'GroupReplicationNotSupport.InvalidParameters', 'errorMessage' => 'Group Replication limits parameters and does not support modification.', ], [ 'errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', ], [ 'errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', ], [ 'errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', ], [ 'errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', ], [ 'errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', ], [ 'errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', ], [ 'errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', ], [ 'errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', ], [ 'errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', ], [ 'errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', ], [ 'errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', ], [ 'errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', ], [ 'errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', ], [ 'errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', ], [ 'errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', ], [ 'errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', ], [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', ], [ 'errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', ], [ 'errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', ], [ 'errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', ], [ 'errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', ], [ 'errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', ], [ 'errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', ], [ 'errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', ], [ 'errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', ], [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', ], [ 'errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', ], [ 'errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', ], [ 'errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', ], [ 'errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', ], [ 'errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', ], [ 'errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', ], [ 'errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', ], [ 'errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', ], [ 'errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', ], [ 'errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', ], [ 'errorCode' => 'OperationDenied.XengineSwitch', 'errorMessage' => 'Current custins can not turn off xengine param.', ], [ 'errorCode' => 'InvalidParameterValue.Limit', 'errorMessage' => 'Parameter value exceeds limit.', ], ], 403 => [ [ 'errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'The current database instance type does not support the operation.', ], [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'The current database status does not support the operation.', ], [ 'errorCode' => 'Invalid.Parameter', 'errorMessage' => 'Specified parameters is not valid.', ], [ 'errorCode' => 'IncorrectEffectiveTime', 'errorMessage' => 'The specified EffectiveTime params is not valid.', ], [ 'errorCode' => 'GroupReplicationNotSupport.InvalidEngineVersion', 'errorMessage' => 'Group Replication requires the instance engine version to be 8.0.', ], [ 'errorCode' => 'GroupReplicationNotSupport.InvalidNodeClassCode', 'errorMessage' => 'Group Replication requires the ClassCode of each node to be consistent.', ], [ 'errorCode' => 'GroupReplicationNotSupport.InvalidNodeNum', 'errorMessage' => 'Group Replication is not supported, the number of nodes must be an odd number greater than or equal to 3.', ], [ 'errorCode' => 'GroupReplicationNotSupport.InvalidXengine', 'errorMessage' => 'Group Replication is not supported because the instance has xengine tables.', ], [ 'errorCode' => 'GroupReplicationNotSupport.MemoryTooSmall', 'errorMessage' => 'Group Replication is not supported because the memory is too small.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'GroupReplicationNotSupport.TableWithoutPrimaryKey', 'errorMessage' => 'Group Replication is not supported because the instance exists table has no primary key.', ], [ 'errorCode' => 'IncorrectDBInstance', 'errorMessage' => 'The current DB instance does not support this operation.', ], [ 'errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', ], [ 'errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', ], [ 'errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', ], [ 'errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', ], [ 'errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', ], [ 'errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', ], [ 'errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', ], [ 'errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', ], [ 'errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', ], [ 'errorCode' => 'InvalidMySQLEngineVersionSupportVector', 'errorMessage' => 'Invalid MySQL Engine Version Support Vector.', ], [ 'errorCode' => 'ReadOnlyInstanceNotSupport', 'errorMessage' => 'Read-only instance does not support this operation.', ], [ 'errorCode' => 'IncorrectEngineVersion', 'errorMessage' => 'The engine version does not support the operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance does not exist or is not supported.', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal_level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', ], [ 'errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', ], [ 'errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', ], [ 'errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', ], [ 'errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', ], [ 'errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', ], ], 500 => [ [ 'errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', ], [ 'errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', ], [ 'errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"16C62438-491B-5C02-9B49-BA924A1372A2\\"\\n}","type":"json"}]', ], 'DescribeImportTaskValidation' => [ 'summary' => '查看数据导入预检查状态', 'path' => '', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '41698****', ], ], [ 'name' => 'DbInstanceId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'rm-xjkljj****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '3E36DB6E-AE3B-53B6-A703-85F883FD1B2C', ], 'Success' => [ 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'Status' => [ 'description' => '', 'type' => 'string', 'example' => 'COMPLETED', ], 'Detail' => [ 'description' => '', 'type' => 'string', 'example' => '{"ValidateAction": "Detail"}', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3E36DB6E-AE3B-53B6-A703-85F883FD1B2C\\",\\n \\"Success\\": true,\\n \\"Status\\": \\"COMPLETED\\",\\n \\"Detail\\": \\"{\\\\\\"ValidateAction\\\\\\": \\\\\\"Detail\\\\\\"}\\"\\n}","type":"json"}]', ], 'DescribeImportTask' => [ 'summary' => '查询原生复制上云任务详情', 'path' => '', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'rm-****', ], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => '159****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => 'A103039D-B1B2-4C57-B989-7D7C0DA95426', ], 'TaskId' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '416980000', ], 'TaskName' => [ 'description' => '', 'type' => 'string', 'example' => 'test01', ], 'Status' => [ 'description' => '', 'type' => 'string', 'example' => 'Importing', ], 'Detail' => [ 'description' => '', 'type' => 'string', 'example' => 'Error Message', ], 'TargetInstanceName' => [ 'description' => '', 'type' => 'string', 'example' => 'rm-t4neh0q12v1******', ], 'TaskType' => [ 'description' => '', 'type' => 'string', 'example' => 'import'."\n", ], 'SourceIp' => [ 'description' => '', 'type' => 'string', 'example' => '59.172.25.122', ], 'SourcePort' => [ 'description' => '', 'type' => 'string', 'example' => '3306', ], 'Account' => [ 'description' => '', 'type' => 'string', 'example' => 'myadmin', ], 'DbVersion' => [ 'description' => '', 'type' => 'string', 'example' => '5.7', ], 'SourceCategory' => [ 'description' => '', 'type' => 'string', 'example' => 'aliyunRDS', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A103039D-B1B2-4C57-B989-7D7C0DA95426\\",\\n \\"TaskId\\": 416980000,\\n \\"TaskName\\": \\"test01\\",\\n \\"Status\\": \\"Importing\\",\\n \\"Detail\\": \\"Error Message\\",\\n \\"TargetInstanceName\\": \\"rm-t4neh0q12v1******\\",\\n \\"TaskType\\": \\"import\\\\n\\",\\n \\"SourceIp\\": \\"59.172.25.122\\",\\n \\"SourcePort\\": \\"3306\\",\\n \\"Account\\": \\"myadmin\\",\\n \\"DbVersion\\": \\"5.7\\",\\n \\"SourceCategory\\": \\"aliyunRDS\\"\\n}","type":"json"}]', ], 'CreateImportTask' => [ 'summary' => '创建数据导入任务', 'path' => '', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'Host', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => '172.20.246.90', ], ], [ 'name' => 'Port', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '65536', 'minimum' => '1', 'example' => '3306', ], ], [ 'name' => 'StreamPort', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '65535', 'minimum' => '1', 'example' => '9999', ], ], [ 'name' => 'User', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'myadmin', ], ], [ 'name' => 'Password', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'OEF5JjVOM2pzZXFKRw==', ], ], [ 'name' => 'SourcePlatform', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ECS', 'enum' => [ 'ECS', 'RdsCustom', ], ], ], [ 'name' => 'SourceInstanceId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'i-bp1fe296n52ub3chezpg', ], ], [ 'name' => 'XtrabackupPath', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => '/usr/bin/xtrabackup', ], ], [ 'name' => 'DbInstanceId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'rm-bp1u*****ggm7j9j', ], ], [ 'name' => 'EstimatedSize', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1000', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '8B993DA9-5272-5414-94E3-4CA8BA0146C2', ], 'TaskId' => [ 'description' => '', 'type' => 'string', 'example' => '3384382', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'INVALID_SOURCE_INSTANCE.RDS_CUSTOM', 'errorMessage' => 'Source RdsCustom instance is not valid to import, please check instance attributes.', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => '%s.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8B993DA9-5272-5414-94E3-4CA8BA0146C2\\",\\n \\"TaskId\\": \\"3384382\\"\\n}","type":"json"}]', ], 'ValidateImportTask' => [ 'summary' => '预检验数据导入任务参数', 'path' => '', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'Host', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => '192.168.10.1', ], ], [ 'name' => 'Port', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '65536', 'minimum' => '1', 'example' => '3306', ], ], [ 'name' => 'StreamPort', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '65535', 'minimum' => '1', 'example' => '9999', ], ], [ 'name' => 'User', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'myadmin', ], ], [ 'name' => 'Password', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'UGFzc3dvcmQxMjMK', ], ], [ 'name' => 'SourcePlatform', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ECS', 'enum' => [ 'ECS', 'RdsCustom', ], ], ], [ 'name' => 'SourceInstanceId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'i-wz9ff3acy500io5wdf5s', ], ], [ 'name' => 'XtrabackupPath', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => '/usr/local/bin/xtrabackup', ], ], [ 'name' => 'DbInstanceId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'rm-sdfljk123****', ], ], [ 'name' => 'EstimatedSize', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '08A3B71B-FE08-4B03-974F-CC7EA6DB1828 ', ], 'TaskId' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '12345'."\n", ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'INVALID_SOURCE_INSTANCE.RDS_CUSTOM', 'errorMessage' => 'Source RdsCustom instance is not valid to import, please check instance attributes.', ], ], ], 'staticInfo' => [ 'returnType' => 'asynchronous', 'callback' => 'Rds::2014-08-15::DescribeImportTaskValidation', 'callbackInterval' => 3000, 'maxCallbackTimes' => 20, ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"08A3B71B-FE08-4B03-974F-CC7EA6DB1828\\\\t\\",\\n \\"TaskId\\": 12345\\n}","type":"json"}]', ], 'ListImportTasks' => [ 'summary' => '查询上云任务列表', 'path' => '', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'rm-uf6wjk5****', ], ], [ 'name' => 'MaxResults', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', ], ], [ 'name' => 'NextToken', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'AAAAAdDWBF2', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC', ], 'Items' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'TaskId' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '342900000', ], 'TaskName' => [ 'description' => '', 'type' => 'string', 'example' => '362c6c7a-4d20-4eac-898c-1495ceab374c', ], 'CreatedTime' => [ 'description' => '', 'type' => 'string', 'example' => '2018-05-30T14:30:00Z', ], 'Status' => [ 'description' => '', 'type' => 'string', 'example' => 'Importing', ], 'DbVersion' => [ 'description' => '', 'type' => 'string', 'example' => '5.7', ], 'TaskType' => [ 'description' => '', 'type' => 'string', 'example' => 'import', ], 'TargetInstanceName' => [ 'description' => '', 'type' => 'string', 'example' => 'rm-bp*****', ], ], ], ], 'NextToken' => [ 'description' => '', 'type' => 'string', 'example' => 'None', ], 'MaxResults' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '30', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC\\",\\n \\"Items\\": [\\n {\\n \\"TaskId\\": 342900000,\\n \\"TaskName\\": \\"362c6c7a-4d20-4eac-898c-1495ceab374c\\",\\n \\"CreatedTime\\": \\"2018-05-30T14:30:00Z\\",\\n \\"Status\\": \\"Importing\\",\\n \\"DbVersion\\": \\"5.7\\",\\n \\"TaskType\\": \\"import\\",\\n \\"TargetInstanceName\\": \\"rm-bp*****\\"\\n }\\n ],\\n \\"NextToken\\": \\"None\\",\\n \\"MaxResults\\": 30\\n}","type":"json"}]', ], 'ModifyImportTask' => [ 'summary' => '修改上云任务', 'path' => '', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'rm-2ze63v2p3o3k****', ], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => '1234567', ], ], [ 'name' => 'Operation', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'CANCEL', 'enum' => [ 'RETRY_IMPORT', 'CANCEL', ], ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => '069EB9B1-DE12-54B9-8C20-822****', ], 'TaskId' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '41698****', ], 'TaskName' => [ 'description' => '', 'type' => 'string', 'example' => 'task_1234', ], 'Status' => [ 'description' => '', 'type' => 'string', 'example' => 'IMPORTING', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"069EB9B1-DE12-54B9-8C20-822****\\",\\n \\"TaskId\\": 0,\\n \\"TaskName\\": \\"task_1234\\",\\n \\"Status\\": \\"IMPORTING\\"\\n}","type":"json"}]', ], 'ModifyRCDiskAttribute' => [ 'summary' => '修改块存储属性', 'path' => '', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'title' => '地域 ID。可调用 DescribeRegions 获取。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'DiskId', 'in' => 'query', 'schema' => [ 'title' => '待修改属性的磁盘 ID。', 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'rcd-wz9c8isqly8637zw****', ], ], [ 'name' => 'DiskName', 'in' => 'query', 'schema' => [ 'title' => '磁盘名称。长度为 2~128 个字符，支持 Unicode 中 letter 分类下的字符（其中包括英文、中文和数字等）。可以包含半角冒号（:）、下划线（_）、半角句号（.）或者短划线（-）。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'testDisk', ], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => [ 'title' => '磁盘描述。 长度为 2~256 个英文或中文字符，不能以http://和https://开头。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'test', ], ], [ 'name' => 'DeleteWithInstance', 'in' => 'query', 'schema' => [ 'title' => '磁盘是否随实例释放。默认值：无，无表示不改变当前的值。'."\n" ."\n" .'开启多重挂载特性的云盘，不支持设置该参数。'."\n" ."\n" .'在下列两种情况下，将参数DeleteWithInstance设置成false时会报错。'."\n" ."\n" .'磁盘的种类（category）为本地盘（ephemeral）时。'."\n" .'磁盘的种类（category）为普通云盘（cloud），且不可以卸载（Portable=false）时。'."\n" .'警告'."\n" .'如果您设置了不随实例释放（DeleteWithInstance=false），一旦磁盘挂载的 ECS 实例被安全锁定且 OperationLocks 中标记了"LockReason" : "security"的锁定状态，释放实例时会忽略磁盘的 DeleteWithInstance 属性而被同时释放。', 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'BurstingEnabled', 'in' => 'query', 'schema' => [ 'title' => '针对支持 Burst（性能突发）的磁盘是否开启此功能，取值范围：'."\n" ."\n" .'true：是。'."\n" .'false：否。'."\n" .'说明'."\n" .'对于不支持 Burst 功能的磁盘，传入任意值将会报错。', 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidRegionId.MalFormed', 'errorMessage' => 'The specified parameter RegionId is not valid.', ], [ 'errorCode' => 'InvalidDiskName.Malformed', 'errorMessage' => 'The specified disk name is wrongly formed.', ], [ 'errorCode' => 'NoAttributeToModify', 'errorMessage' => 'No attribute to be modified in this request.', ], [ 'errorCode' => 'IncompleteParamter', 'errorMessage' => 'Some fields can not be null in this request.', ], [ 'errorCode' => 'MissingParameter.DiskIdOrDiskIds', 'errorMessage' => 'Specified parameter DiskId or DiskIds is missing.', ], [ 'errorCode' => 'BurstingEnabledForDiskCategoryUnsupported', 'errorMessage' => 'The specified disk category does not support bursting enabled.', ], [ 'errorCode' => 'BurstingEnabledForMultiAttachDiskUnsupported', 'errorMessage' => 'The multi attach disk does not support bursting enabled.', ], [ 'errorCode' => 'BurstingEnabledForModifyingDiskUnsupported', 'errorMessage' => 'The modifying disk does not support bursting enabled.', ], [ 'errorCode' => 'InvalidBurstingEnabled.DiskSizeTooSmall', 'errorMessage' => 'The disk size must be greater than 3 GiB to enable burst.', ], ], 403 => [ [ 'errorCode' => 'QuotaExceed.Snapshot', 'errorMessage' => 'The snapshot quota exceeds.', ], [ 'errorCode' => 'DiskNotPortable', 'errorMessage' => 'The specified disk is not a portable disk.', ], [ 'errorCode' => 'IncorrectDiskStatus', 'errorMessage' => 'The operation is not supported in this status.', ], [ 'errorCode' => 'UserNotInTheWhiteList', 'errorMessage' => 'The user is not in disk white list.', ], [ 'errorCode' => 'DeleteWithInstance.Conflict', 'errorMessage' => 'Multi attach disk cannot be set to DeleteWithInstance attribute.', ], ], [ [ 'errorCode' => 'InvalidDiskId.NotFound', 'errorMessage' => 'The specified disk does not exist.', ], [ 'errorCode' => 'InvalidDescription.Malformed', 'errorMessage' => 'The specified description is wrongly formed.', ], [ 'errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'Specified attached instance does not exist.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC\\"\\n}","type":"json"}]', ], ], 'endpoints' => [ [ 'regionId' => 'ap-southeast-6', 'endpoint' => 'rds.ap-southeast-6.aliyuncs.com', ], [ 'regionId' => 'cn-qingdao', 'endpoint' => 'rds.aliyuncs.com', ], [ 'regionId' => 'cn-beijing', 'endpoint' => 'rds.aliyuncs.com', ], [ 'regionId' => 'cn-zhangjiakou', 'endpoint' => 'rds.cn-zhangjiakou.aliyuncs.com', ], [ 'regionId' => 'cn-huhehaote', 'endpoint' => 'rds.cn-huhehaote.aliyuncs.com', ], [ 'regionId' => 'cn-wulanchabu', 'endpoint' => 'rds.cn-wulanchabu.aliyuncs.com', ], [ 'regionId' => 'cn-hangzhou', 'endpoint' => 'rds.aliyuncs.com', ], [ 'regionId' => 'cn-shanghai', 'endpoint' => 'rds.aliyuncs.com', ], [ 'regionId' => 'cn-shenzhen', 'endpoint' => 'rds.aliyuncs.com', ], [ 'regionId' => 'cn-heyuan', 'endpoint' => 'rds.aliyuncs.com', ], [ 'regionId' => 'cn-guangzhou', 'endpoint' => 'rds.cn-guangzhou.aliyuncs.com', ], [ 'regionId' => 'cn-chengdu', 'endpoint' => 'rds.cn-chengdu.aliyuncs.com', ], [ 'regionId' => 'cn-hongkong', 'endpoint' => 'rds.aliyuncs.com', ], [ 'regionId' => 'ap-northeast-1', 'endpoint' => 'rds.ap-northeast-1.aliyuncs.com', ], [ 'regionId' => 'ap-southeast-1', 'endpoint' => 'rds.ap-southeast-1.aliyuncs.com', ], [ 'regionId' => 'ap-southeast-3', 'endpoint' => 'rds.ap-southeast-3.aliyuncs.com', ], [ 'regionId' => 'ap-southeast-5', 'endpoint' => 'rds.ap-southeast-5.aliyuncs.com', ], [ 'regionId' => 'us-east-1', 'endpoint' => 'rds.us-east-1.aliyuncs.com', ], [ 'regionId' => 'us-west-1', 'endpoint' => 'rds.us-west-1.aliyuncs.com', ], [ 'regionId' => 'eu-west-1', 'endpoint' => 'rds.eu-west-1.aliyuncs.com', ], [ 'regionId' => 'eu-central-1', 'endpoint' => 'rds.eu-central-1.aliyuncs.com', ], [ 'regionId' => 'me-east-1', 'endpoint' => 'rds.me-east-1.aliyuncs.com', ], [ 'regionId' => 'cn-hangzhou-finance', 'endpoint' => 'rds.aliyuncs.com', ], [ 'regionId' => 'cn-shanghai-finance-1', 'endpoint' => 'rds.aliyuncs.com', ], [ 'regionId' => 'cn-shenzhen-finance-1', 'endpoint' => 'rds.cn-shenzhen-finance-1.aliyuncs.com', ], [ 'regionId' => 'cn-beijing-finance-1', 'endpoint' => 'rds.aliyuncs.com', ], [ 'regionId' => 'na-south-1', 'endpoint' => 'rds.na-south-1.aliyuncs.com', ], ], ];